Commit edd9f7b8 authored by Fup Duck's avatar Fup Duck
Browse files

Fix links and project names.

Also replaces some backticks by quotation marks to make the README
easier to read.
parent a71d9012
# [Webschleuder](https://git.codecoop.org/schleuder/webschleuder3) on `docker` # [schleuder-web](https://0xacab.org/schleuder/schleuder-web) on docker
This repo contains `docker` configuration for `schleuder-web`, a web interface for an encrypted group email system `schleuder`. This repo contains a docker configuration for "schleuder-web", a web interface for an encrypted group email system "schleuder".
See: See:
* https://git.codecoop.org/schleuder/schleuder * https://0xacab.org/schleuder/schleuder
* https://git.codecoop.org/schleuder/schleuder-conf * https://0xacab.org/schleuder/schleuder-web
* https://0xacab.org/schleuder/schleuder-cli
If a valid database is not found, `rake db:setup` is run inside the container to set-up a basic valid database. If a valid database is not found, `rake db:setup` is run inside the container to set-up a basic valid database.
## Communication with `schleuder-api-daemon` ## Communication with "schleuder-api-daemon"
This image requires a `schleuder-api-daemon` running somewhere and accessible via `TCP/IP` -- one option is to run the [`schlocker3` docker image](https://git.occrp.org/libre/schlocker3/). You can configure the `schleuder-api-daemon` host with the `WEBSCHLOCKER_CONFIG_API_HOST` environment variable described below. This image requires a "schleuder-api-daemon" running somewhere and accessible via TCP/IP -- one option is to run the ["schlocker" docker image](https://0xacab.org/schleuder/schlocker). You can configure the "schleuder-api-daemon" host with the `WEBSCHLOCKER_CONFIG_API_HOST` environment variable described below.
## Running and testing ## Running and testing
You need `docker`, obviously. So first, [go and install it](https://docs.docker.com/engine/installation/). Then get `schleuderd` running. We'll assume you're [using the `schlocker3` docker image](https://git.occrp.org/libre/schlocker3/#running-and-testing) for this. Once you have `schlocker3` running, run `webschlocker3`: You need `docker`, obviously. So first, [go and install it](https://docs.docker.com/engine/installation/). Then get "schleuder-api-daemon" running. We'll assume you're [using the "schlocker" docker image](https://0xacab.org/schleuder/schlocker/#running-and-testing) for this. Once you have "schlocker" running, run "schlocker-web":
``` ```
$ git clone https://git.occrp.org/libre/webschlocker3.git $ git clone https://0xacab.org/schleuder/schlocker-web.git
$ docker build -t 'webschlocker3' webschlocker3/ $ docker build -t 'schlocker-web' schlocker-web
$ docker run --rm --name webschlocker-test --link schlocker-test -e WEBSCHLOCKER_CONFIG_API_HOST="schlocker-test" -e WEBSCHLOCKER_CONFIG_TLS_FINGERPRINT="fingerprint_from_schlocker_output" -e WEBSCHLOCKER_CONFIG_API_KEY="api_key_given_also_to_schlocker" webschlocker3 $ docker run --rm --name schlocker-web-test --link schlocker-test -e WEBSCHLOCKER_CONFIG_API_HOST="schlocker-test" -e WEBSCHLOCKER_CONFIG_TLS_FINGERPRINT="fingerprint_from_schlocker_output" -e WEBSCHLOCKER_CONFIG_API_KEY="api_key_given_also_to_schlocker" schlocker-web
``` ```
By default `schleuder-web` listens on port `3000` (you can change this by setting `$WEBSCHLOCKER_BIND_PORT` docker envvar) and will inform you about the IP address it is running on in the output. By default "schleuder-web" listens on port 3000 (you can change this by setting `$WEBSCHLOCKER_BIND_PORT` docker envvar) and will inform you about the IP address it is running on in the output.
Once you have that, navigate your browser to `http://<IP-of-the-container>:3000/` and log-in with user `root@localhost`, password `slingit!`. Once you have that, navigate your browser to http://<IP-of-the-container>:3000/ and log-in with user `root@localhost`, password `slingit!`.
## Environment variables ## Environment variables
- `WEBSCHLOCKER_CONFIG_HOSTNAME` (default: container's hostname) - `WEBSCHLOCKER_CONFIG_HOSTNAME` (default: container's hostname)
The hostname `schleuder-web` will run under, used among others in confirmation links sent to users. The hostname "schleuder-web" will run under, used among others in confirmation links sent to users.
- `WEBSCHLOCKER_BIND_ADDRESS` (default: `0.0.0.0`) - `WEBSCHLOCKER_BIND_ADDRESS` (default: `0.0.0.0`)
- `WEBSCHLOCKER_BIND_PORT` (default: `3000`) - `WEBSCHLOCKER_BIND_PORT` (default: `3000`)
...@@ -41,11 +42,11 @@ Hostname (or IP address) and port to bind to. ...@@ -41,11 +42,11 @@ Hostname (or IP address) and port to bind to.
- `WEBSCHLOCKER_CONFIG_API_HOST` (default: `localhost`) - `WEBSCHLOCKER_CONFIG_API_HOST` (default: `localhost`)
Host the `schleuderd` daemon can be reached at. Host the "schleuder-api-daemon" can be reached at.
- `WEBSCHLOCKER_CONFIG_API_PORT` (default: `4443`) - `WEBSCHLOCKER_CONFIG_API_PORT` (default: `4443`)
Port the `schleuderd` daemon can be reached at. Port the "schleuder-api-daemon" can be reached at.
- `WEBSCHLOCKER_CONFIG_MAILER_FROM` (default: `noreply@$WEBSCHLOCKER_CONFIG_HOSTNAME`) - `WEBSCHLOCKER_CONFIG_MAILER_FROM` (default: `noreply@$WEBSCHLOCKER_CONFIG_HOSTNAME`)
...@@ -53,7 +54,7 @@ Sender address for all the e-mails originating from the web interface (i.e. conf ...@@ -53,7 +54,7 @@ Sender address for all the e-mails originating from the web interface (i.e. conf
- `WEBSCHLOCKER_CONFIG_DELIVERY_METHOD` (default: `smtp`) - `WEBSCHLOCKER_CONFIG_DELIVERY_METHOD` (default: `smtp`)
Delivery method to use for outgoing e-mail; `schleuder-web` uses [`ActionMailer`](http://api.rubyonrails.org/classes/ActionMailer/Base.html) to send mail. Delivery method to use for outgoing e-mail; "schleuder-web" uses [`ActionMailer`](http://api.rubyonrails.org/classes/ActionMailer/Base.html) to send mail.
- `WEBSCHLOCKER_CONFIG_SENDMAIL_ARGUMENTS` (default: `-i`) - `WEBSCHLOCKER_CONFIG_SENDMAIL_ARGUMENTS` (default: `-i`)
...@@ -74,7 +75,7 @@ Secret used to verify encrypted cookies; can be changed at any time (change caus ...@@ -74,7 +75,7 @@ Secret used to verify encrypted cookies; can be changed at any time (change caus
### Database settings ### Database settings
Separate databases are used by `schleuder3` and `schleuder-web`; these settings should thus be different from the ones used for [`schlocker3`](https://git.occrp.org/libre/schlocker3/). Separate databases are used by "schleuder" and "schleuder-web"; these settings should thus be different from the ones used for "[schlocker](https://git.occrp.org/libre/schlocker3/)".
- `WEBSCHLOCKER_DB_ADAPTER` (default: `sqlite3`) - `WEBSCHLOCKER_DB_ADAPTER` (default: `sqlite3`)
...@@ -103,4 +104,4 @@ Database host (not used for `sqlite3`). ...@@ -103,4 +104,4 @@ Database host (not used for `sqlite3`).
## TODO ## TODO
- handle more [`ActionMailer` config options](http://api.rubyonrails.org/classes/ActionMailer/Base.html) - handle more [`ActionMailer` config options](http://api.rubyonrails.org/classes/ActionMailer/Base.html)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment