rooty/fab-manager
1
0
Fork 0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2025-01-17 06:52:27 +01:00
Code Issues Releases Activity

update setup script and instructions

Browse Source
This commit is contained in:
Sylvain 2019-12-24 16:19:44 +01:00
parent 47cf32e67c
commit 4fb72cfd74
2 changed files with 40 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/docker-compose_readme.md
View File

@ -100,13 +100,11 @@ You can run the following script as root to easily perform all these operations:
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/setup.sh | bash -s "/my/custom/path" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/setup.sh | bash -s "/my/custom/path"
``` ```
### Setup folders and env file ### Setup env file
Create the config folder, copy the environnement variables configuration file and edit it: Configure the environnement variables file:
```bash ```bash
mkdir -p /apps/fabmanager/config
cd /apps/fabmanager cd /apps/fabmanager
cp example/env.example config/env
vi config/env vi config/env
# or use your favorite text editor instead of vi (nano, ne...) # or use your favorite text editor instead of vi (nano, ne...)
``` ```
@ -116,14 +114,8 @@ Please refer to the [environment configuration documentation](environment.md) fo
### Setup nginx configuration ### Setup nginx configuration
Create the nginx folder, copy the example configuration file and edit it: Edit the nginx configuration file:
```bash ```bash
mkdir -p /apps/fabmanager/config/nginx
# whether you want you fab-manager to use SSL encryption or not, you should copy one of the following file
### with SSL ###
cp example/nginx_with_ssl.conf.example config/nginx/fabmanager.conf
### OR without SSL ###
cp example/nginx.conf.example config/nginx/fabmanager.conf
vi config/nginx/fabmanager.conf vi config/nginx/fabmanager.conf
# or use your favorite text editor instead of vi (nano, ne...) # or use your favorite text editor instead of vi (nano, ne...)
@ -131,16 +123,14 @@ vi config/nginx/fabmanager.conf
Customize the following values: Customize the following values:
* Replace **MAIN_DOMAIN** (example: fab-manager.com). * Replace **MAIN_DOMAIN** (example: fab-manager.com).
* Replace **URL_WITH_PROTOCOL_HTTPS** (example: https://www.fab-manager.com).
* Replace **ANOTHER_URL_1**, **ANOTHER_URL_2** (example: .fab-manager.fr)
### SSL certificate with LetsEncrypt ### SSL certificate with LetsEncrypt
**FOLLOW THOSE INSTRUCTIONS ONLY IF YOU WANT TO USE SSL**. **FOLLOW THOSE INSTRUCTIONS ONLY IF YOU WANT TO USE SSL**.
If you have chosen the SSL configuration at the previous point, you must follow these instructions to make it work. If you want to host you Fab-manager instance through SSL (which is highly recommended), you must follow the following instructions.
Let's Encrypt is a new Certificate Authority that is free, automated, and open. Let's Encrypt is a Certificate Authority that is free, automated, and open.
Let’s Encrypt certificates expire after 90 days, so automation of renewing your certificates is important. Let’s Encrypt certificates expire after 90 days, so automation of renewing your certificates is important.
Here is the setup for a systemd timer and service to renew the certificates and reboot the app Docker container: Here is the setup for a systemd timer and service to renew the certificates and reboot the app Docker container:
@ -151,13 +141,8 @@ cd /apps/fabmanager/config/nginx/ssl
openssl dhparam -out dhparam.pem 4096 openssl dhparam -out dhparam.pem 4096
``` ```
Copy the initial configuration file and customize it Customize the let's encrypt configuration file
```bash ```bash
cd /apps/fabmanager/
mkdir -p letsencrypt/config/
mkdir -p letsencrypt/etc/webrootauth
cp example/webroot.ini.example /apps/fabmanager/letsencrypt/config/webroot.ini
vi letsencrypt/config/webroot.ini vi letsencrypt/config/webroot.ini
# or use your favorite text editor instead of vi (nano, ne...) # or use your favorite text editor instead of vi (nano, ne...)
``` ```
@ -173,8 +158,8 @@ Requires=docker.service
[Service] [Service]
Type=oneshot Type=oneshot
ExecStart=/usr/bin/docker run --rm --name letsencrypt -v "/apps/fabmanager/log:/var/log/letsencrypt" -v "/apps/fabmanager/letsencrypt/etc:/etc/letsencrypt" -v "/apps/fabmanager/letsencrypt/config:/letsencrypt-config" quay.io/letsencrypt/letsencrypt:latest -c "/letsencrypt-config/webroot.ini" certonly ExecStart=/usr/bin/docker run --rm --name certbot_fabmanager -v "/apps/fabmanager/letsencrypt:/etc/letsencrypt" certbot/certbot:latest -c "/etc/letsencrypt/config/webroot.ini" certonly
ExecStartPost=-/usr/bin/docker restart fabmanager_nginx_1 ExecStartPost=-/usr/bin/docker restart fabmanager_nginx_1
``` ```
Create file (with sudo) /etc/systemd/system/letsencrypt.timer and paste the following configuration into it: Create file (with sudo) /etc/systemd/system/letsencrypt.timer and paste the following configuration into it:
@ -245,7 +230,7 @@ docker-compose run --rm -e ADMIN_EMAIL=xxx -e ADMIN_PASSWORD=xxx fabmanager bund
`docker-compose up -d` `docker-compose up -d`
<a name="generate-ssl-cert-letsencrypt"></a> <a name="generate-ssl-cert-letsencrypt"></a>
### Generate SSL certificate by Let's encrypt ### Generate SSL certificate by Let's encrypt
**Important: app must be run on http before starting letsencrypt** **Important: app must be run on http before starting letsencrypt**
@ -254,8 +239,19 @@ Start letsencrypt service :
sudo systemctl start letsencrypt.service sudo systemctl start letsencrypt.service
``` ```
If the certificate was successfully generated then update the nginx configuration file and activate the ssl port and certificate If the certificate was successfully generated, you must update the nginx configuration to activate the ssl port and certificate.
editing the file `/apps/fabmanager/config/nginx/fabmanager.conf`. editing the file `/apps/fabmanager/config/nginx/fabmanager.conf`.
```bash
mv /apps/fabmanager/config/nginx/fabmanager.conf /apps/fabmanager/config/nginx/fabmanager.conf.nossl
cp /apps/fabmanager/config/nginx/fabmanager.conf.ssl /apps/fabmanager/config/nginx/fabmanager.conf
vi /apps/fabmanager/config/nginx/fabmanager.conf
# or use your favorite text editor instead of vi (nano, ne...)
```
Customize the following values:
* Replace **MAIN_DOMAIN** (example: fab-manager.com).
* Replace **URL_WITH_PROTOCOL_HTTPS** (example: https://www.fab-manager.com).
* Replace **ANOTHER_URL_1**, **ANOTHER_URL_2** (example: .fab-manager.fr)
Remove your app container and run your app to apply the changes running the following commands: Remove your app container and run your app to apply the changes running the following commands:
```bash ```bash
@ -263,7 +259,7 @@ docker-compose down
docker-compose up -d docker-compose up -d
``` ```
Finally, if everything is ok, start letsencrypt timer to update the certificate every 1st of the month : Finally, if everything is ok, start let's encrypt timer to update the certificate every 1st of the month :
```bash ```bash
sudo systemctl enable letsencrypt.timer sudo systemctl enable letsencrypt.timer
@ -274,6 +270,7 @@ sudo systemctl list-timers
<a name="docker-utils"></a> <a name="docker-utils"></a>
## Docker utils with docker-compose ## Docker utils with docker-compose
Below, you'll find a collection of useful commands to control your instance with docker-compose
### Restart app ### Restart app

25
setup/setup.sh
View File

@ -4,25 +4,34 @@ prepare_config()
{ {
FABMANAGER_PATH=${1:-/apps/fabmanager} FABMANAGER_PATH=${1:-/apps/fabmanager}
mkdir -p "$FABMANAGER_PATH/example" mkdir -p "$FABMANAGER_PATH/config/nginx/ssl"
mkdir -p "$FABMANAGER_PATH/letsencrypt/config"
mkdir -p "$FABMANAGER_PATH/letsencrypt/etc/webrootauth"
mkdir -p "$FABMANAGER_PATH/elasticsearch/config" mkdir -p "$FABMANAGER_PATH/elasticsearch/config"
# fab-manager environment variables # fab-manager environment variables
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/env.example > "$FABMANAGER_PATH/example/env.example" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/env.example > "$FABMANAGER_PATH/config/env"
# nginx configuration # nginx configuration
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/nginx_with_ssl.conf.example > "$FABMANAGER_PATH/example/nginx_with_ssl.conf.example" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/nginx_with_ssl.conf.example > "$FABMANAGER_PATH/config/nginx/fabmanager.conf.ssl"
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/nginx.conf.example > "$FABMANAGER_PATH/example/nginx.conf.example" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/nginx.conf.example > "$FABMANAGER_PATH/config/nginx/fabmanager.conf"
# let's encrypt configuration # let's encrypt configuration
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/webroot.ini.example > "$FABMANAGER_PATH/example/webroot.ini.example" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/webroot.ini.example > "$FABMANAGER_PATH/letsencrypt/config/webroot.ini"
# ElasticSearch configuration files # ElasticSearch configuration files
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/elasticsearch.yml > "$FABMANAGER_PATH/elasticsearch/config/elasticsearch.yml" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/elasticsearch.yml > "$FABMANAGER_PATH/elasticsearch/config/elasticsearch.yml"
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/log4j2.properties > "$FABMANAGER_PATH/elasticsearch/config/log4j2.properties" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/log4j2.properties > "$FABMANAGER_PATH/elasticsearch/config/log4j2.properties"
# docker-compose # docker-compose
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/docker/docker-compose.yml > "$FABMANAGER_PATH/docker-compose.yml" \curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/docker-compose.yml > "$FABMANAGER_PATH/docker-compose.yml"
} }
function trap_ctrlc()
{
echo "Ctrl^C, exiting..."
exit 2
}
trap "trap_ctrlc" 2 # SIGINT
prepare_config "$@" prepare_config "$@"