pub-solar/obs-portal
5
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Improve the README

Browse source
This commit is contained in:
Dennis Boldt 2022-01-03 14:45:13 +01:00 committed by Paul Bienkowski
parent 1735f44769
commit 412349cf4f
2 changed files with 52 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
deployment/README.md
View file

@ -13,6 +13,12 @@ corresponding docker containers.
This guide requires a Linux-system, where `docker` and `docker-compose` are installed. This guide requires a Linux-system, where `docker` and `docker-compose` are installed.
Ensure, that your system is up to date. Ensure, that your system is up to date.
> TODO
```bash
apt install docker.io docker-compose pwgen
```
## Before Getting Started ## Before Getting Started
The example configurations assume two domains, which points to the The example configurations assume two domains, which points to the
@ -27,7 +33,11 @@ First of all, login into your system via SSH.
### Create working directory ### Create working directory
Create a folder somewhere in your system, in this guide we use Create a folder somewhere in your system, in this guide we use
`/opt/openbikesensor`. `/opt/openbikesensor`:
```bash
mkdir /opt/openbikesensor
```
### Clone the repository ### Clone the repository
@ -74,16 +84,19 @@ Configure your email in the `config/traefik.toml`. This email is used by
#### Start Traefik #### Start Traefik
```bash ```bash
cd /opt/openbikesensor/
docker-compose up -d traefik docker-compose up -d traefik
docker-compose logs -f traefik docker-compose logs -f traefik
``` ```
> traefik_1 | time="2022-01-03T13:02:36Z" level=info msg="Configuration loaded from file: /traefik.toml"
### Generate passwords ### Generate passwords
Generate three passords, for example with `pwgen`: Generate three passords, for example with `pwgen`:
```bash ```bash
pwgen -2 -n 20 pwgen -n 20
``` ```
They will be uses in the next steps. They will be uses in the next steps.
@ -100,18 +113,32 @@ nano .env
Configure: Configure:
* `OBS_KEYCLOAK_URI`: * `OBS_KEYCLOAK_URI`:
* The subdomain of your keycloak * The subdomain of your keycloak
* `OBS_KEYCLOAK_POSTGRES_PASSWORD` and `OBS_KEYCLOAK_ADMIN_PASSWORD`: * `OBS_KEYCLOAK_POSTGRES_PASSWORD`
* One of the generated passwords for the KeyCloak-postgres * One of the generated passwords for the KeyCloak-postgres
* `OBS_KEYCLOAK_ADMIN_PASSWORD`:
* One of the generated passwords for the KeyCloak-admin
* `OBS_KEYCLOAK_PORTAL_REDIRECT_URI`: * `OBS_KEYCLOAK_PORTAL_REDIRECT_URI`:
* The Redirect URI, e.g. the subdomain of your portal (ensure, it ends with `/*`) * The Redirect URI, e.g. the subdomain of your portal (ensure, it ends with `/*`)
#### Start KeyCloak
```bash
docker-compose up -d keycloak
docker-compose logs -f keycloak
```
Wait until postgres and keycloak are started: Wait until postgres and keycloak are started:
* https://login.dennisboldt.de/ > keycloak_1 | 13:08:55,558 INFO [org.jboss.as] (Controller Boot Thread) WFLYSRV0051: Admin console listening on http://127.0.0.1:9990
Open:
* https://login.example.com/
* Test login to the admin console with your admin account
#### Configure Realm and Client #### Configure Realm and Client
Login into your KeyCloak: Jump into the KeyCloak container:
```bash ```bash
docker-compose exec keycloak /bin/bash docker-compose exec keycloak /bin/bash
@ -135,11 +162,9 @@ CID=$(/opt/jboss/keycloak/bin/kcadm.sh create clients -r $OBS_KEYCLOAK_REALM -s
# Get the secret of the client # Get the secret of the client
/opt/jboss/keycloak/bin/kcadm.sh get clients/$CID/client-secret -r $OBS_KEYCLOAK_REALM /opt/jboss/keycloak/bin/kcadm.sh get clients/$CID/client-secret -r $OBS_KEYCLOAK_REALM
exit
``` ```
Now, configure the client secret: Exit the container with `exit`. Configure the client secret:
```bash ```bash
cd /opt/openbikesensor/ cd /opt/openbikesensor/
@ -153,8 +178,8 @@ Configure:
#### Create a user #### Create a user
* Login into your Keycloak with the admin user and select the realm obs * Login into your Keycloak with the admin user and select the realm obs
* Create a user with username and email (*Hint*: email is required by the portal) * Create a user with username and email for the realm `obs` (*Hint*: email is required by the portal)
* Configure a password as well * Configure a password in the tab `Credentials` as well
### Portal ### Portal
@ -166,7 +191,6 @@ nano .env
``` ```
Configure: Configure:
* `OBS_POSTGRES_HOST`: * `OBS_POSTGRES_HOST`:
* The should be the postgres-container, e.g. `postgres` * The should be the postgres-container, e.g. `postgres`
* `OBS_POSTGRES_USER`: * `OBS_POSTGRES_USER`:
@ -184,8 +208,12 @@ Configure:
``` ```
cd /opt/openbikesensor/ cd /opt/openbikesensor/
docker-compose up -d postgres docker-compose up -d postgres
docker-compose logs -f docker-compose logs -f postgres
``` ```
Wait until started:
> postgres_1 | PostgreSQL init process complete; ready for start up.
#### Build the portal image #### Build the portal image
@ -274,19 +302,24 @@ Have a look into the `config.py`, which other variables may affect you.
```bash ```bash
cd /opt/openbikesensor/ cd /opt/openbikesensor/
docker-compose up -d portal docker-compose up -d portal
docker-compose logs -f portal worker
``` ```
> portal_1 | [2022-01-03 13:37:48 +0000] [1] [INFO] Goin' Fast @ http://0.0.0.0:3000
This also starts a dedicated worker container to handle the tracks. This also starts a dedicated worker container to handle the tracks.
#### Test the portal #### Test the portal
* Open: https://obs.example.com/ * Open: https://obs.example.com/
* Login with the user * Login with the user
* Upload a track * Upload a track via My Tracks
You should see smth. like: You should see smth. like:
> worker_1 | INFO: Track 10b9ulou imported. > worker_1 | INFO: Track uuqvcvlm imported.
When you click on *My Tracks*, you should see it on a map.
#### Configre the map position #### Configre the map position
@ -295,7 +328,7 @@ for example:
> 14/53.86449349032097/10.696108517499198 > 14/53.86449349032097/10.696108517499198
Configure the map position in the `config.py` and restart the portal: Configure the map position in the `config.py` and restart the portal, by setting `mapHome` in the variable `FRONTEND_CONFIG`:
``` ```
cd /opt/openbikesensor/ cd /opt/openbikesensor/
@ -304,9 +337,10 @@ nano config/config.py
docker-compose restart portal docker-compose restart portal
``` ```
The tab *Map* should be the selected map section now. **Hint**: Maybe it's required to disable the browser cache to see the change.
**Hint**: Probably it's required to disable the browser cache to see the change. The tab *Map* should be the selected map section now.
When you uploaded some tracks, you map should show a colors overlay on the streets.
#### Verify osm2pgsql #### Verify osm2pgsql

2
deployment/examples/.env
View file

@ -16,7 +16,7 @@ OBS_KEYCLOAK_POSTGRES_HOST=postgres-keycloak
OBS_KEYCLOAK_ADMIN_USER=admin OBS_KEYCLOAK_ADMIN_USER=admin
OBS_KEYCLOAK_ADMIN_PASSWORD=<<TODO>> OBS_KEYCLOAK_ADMIN_PASSWORD=<<TODO>>
OBS_KEYCLOAK_REALM=obs OBS_KEYCLOAK_REALM=obs
OBS_KEYCLOAK_PORTAL_REDIRECT_URI=https://obs.example.com/* OBS_KEYCLOAK_PORTAL_REDIRECT_URI=https://portal.example.com/*
################################################### ###################################################
# Portal # Portal