Under the Hood: Installation wizard

Not yet merged but hopefully soon to be is the new installation wizard.

It is implemented as a web-app and the corresponding API, but not started with the rest of the server but with it’s own start script, installation.sh

But also if you start loklak via start.sh, you will be asked if you want to start the installation wizard. Don’t worry, if you don’t do anything, the prompt will just time out and loklak will start as usually. You can do the installation at any time later.

installation0

So here are the steps that the wizard currently offers:

1. Admin account creation

installation1

2. User registration settings (currently only whether and with what confirmation users can register)

3. General settings

  • the host url (which is read from the browser url and therefor makes it easy to set the actual url, even on one-click deployments)
  • the peer name, to make installations identifiable more easily
  • back-end settings

installation3

4. SMTP-Settings: configure loklak to send mails via an existing email account (with test option). You will probably wonder why there are alot of options. Well, we have

  • the server to connect to (not necessarily equal to the email address)
  • the email address to put into the header (can be any one that the server permits. for example if have an alias registered on the server, you can set it here)
  • the name to display with the email
  • the actual login name (often the email-address, but not necessarily!)
  • the password
  • the port (usually dependent on the encryption mode, but again not necessary)
  • the encryption mode (today usually startTLS or TLS)
  • disable certificate checking if you’re using a server with self signed certificate or are behind a ssl-proxy

In a future version, we can maybe include a mechanism to automatically try to fill out some fields from other values, like many mail clients do, but that’s quite some work and usually involves a database with host specific values.

5. HTTPS-Settings: activate HTTPS for Loklak (if you don’t use a HTTP-Proxy as loklak.org and the one-click-deployments do) and configure whether Loklak should check certificates from other hosts it connects to. This can be useful if you are behind an SSL-Proxy.

installation5

6. A summary of all values

installation6

After submitting (and if no error is thrown by the server), the installation wizard wil shut down

installation7

If you started the installation with the normal start script, it will continue to start loklak as usual

installation8

Beware: sometimes the browser does not really refresh and will continue showing parts of the installation page instead of the normal Loklak page. If that happens, just clean your cache.

Under the Hood: Installation wizard