3.7 KiB
Vervis is still in early development. These instructions may be incomplete and/or slightly outdated. At the time of writing, you can get a running Vervis instance if you follow the steps below.
Check the version of OpenSSL installed on your system. For example:
$ apt show openssl
Currently Vervis is using a slightly old software configuration, and until I fix that, it doesn't build with OpenSSL 1.1 and needs the older 1.0 or 1.0.1 version. If your distro has 1.1, see if you can grab 1.0 or 1.0.1 in some way, either through the distro package or by downloading OpenSSL manually from its website, or some alternative package manager such as GNU Guix.
Install dependency library development packages. It's very likely you already have them all installed, and if you're missing some, the build process will inform you. But it's still nice to have a list here. The list below isn't a complete list, it's just libraries that people have found missing while building, and let me know.
- PostgreSQL client library
- ZLib
On Debian based distros, installation can be done like this:
$ sudo apt install libpq-dev zlib1g-dev
Install stack. To install stack, go to its website and follow the instructions. If you have some old version, such as one installed from FPComplete's old debian repo, you may need to upgrade it.
Install Darcs. You can grab it from your distro, e.g.:
$ sudo apt install darcs
If you're going to create a Git repository on Vervis, you'll need Git too, you can install it from a distro package too, e.g.:
$ sudo apt install git
Clone the Vervis repo:
$ darcs clone https://dev.seek-together.space/s/fr33domlover/r/vervis
$ cd vervis
Install GHC. Unless you prefer to use a distro package or PPA or some other source, the easiest way is to install via stack:
$ stack setup
Check in stack.yaml near the top which extra repos are required. At the time
of writing, there are 4 of them (hit-harder, hit-graph, hit-network and
ssh). Then clone them. For example:
$ darcs clone https://dev.seek-together.space/s/fr33domlover/r/ssh
Those extra repos should be found at the Vervis project page. If something is missing there, try my Darcs Hub page. I'm sorry I'm not just listing the URLs here. These things have been changing often, but once they stabilize I will update the docs, and also make releases of all these extra libraries.
Update stack.yaml to specify that path in the packages section if needed:
$ vim stack.yml
Generate a new SSH key with a blank password:
$ ssh-keygen -t rsa -f config/ssh-host-key
Install PostgreSQL. You'll need the server and the client library development files.
$ sudo apt-get install postgresql libpq-dev
Switch to postgres system user:
$ sudo su - postgres
Create a PostgreSQL user.
With password:
$ createuser --no-createdb --no-createrole --no-superuser --encrypted --pwprompt vervis
No password (if you run Vervis as a user by the same name as the DB user):
$ createuser --no-createdb --no-createrole --no-superuser vervis
Create a PostgreSQL database:
$ createdb --encoding=UTF8 --owner=vervis vervis
Update the settings to specify correct database connection details and other settings.
$ cp config/settings-default.yaml config/settings.yml
$ vim config/settings.yml
Build.
$ stack build
Run.
$ stack exec vervis
Browse to http://localhost:3000 and have fun!
yesod devel is another way to run the application, useful for rapid
development, but I haven't been using it and I'm not sure it works, possibly I
broke something along the way. But feel free to try!