From 0c9d7913c9a78e51eca5629e3a784a8a7778c9f9 Mon Sep 17 00:00:00 2001
From: Julien Jerphanion <git@jjerphan.xyz>
Date: Wed, 6 Feb 2019 22:59:19 +0100
Subject: [PATCH] Documenting ; changing shebang
---
README.md | 38 +++++++++++++++++++++
backup-rotation/README.md | 37 ++++++++++----------
checkmk/README.md | 14 ++++----
database/Mongo/README | 4 +--
database/Mongo/run.sh | 3 +-
database/Mongo/runScript.sh | 3 +-
database/Mongo/set_mongodb_password.sh | 2 +-
database/Redis/README | 2 +-
database/Redis/runScript.sh | 1 +
db-backup/README.md | 37 ++++++++++----------
db-backup/mongo-run.sh | 2 +-
db-backup/mysql-run.sh | 2 +-
db-backup/run.sh | 6 ++--
framadate/README.md | 2 +-
framadate/entrypoint.sh | 2 +-
grafana/README.md | 6 +++-
mattermost-cleaner/README.md | 28 ++++++++-------
mattermost-cleaner/cron.sh | 2 +-
mattermost-cleaner/psqlcmd.sh | 2 +-
minetest/README.md | 21 ++++++------
minetest/entrypoint.sh | 3 +-
mysql-backup/README.md | 47 ++++++++++++++------------
pica-apache/run.sh | 2 +-
pica-dokuwiki/run.sh | 2 +-
pica-etherpad/entrypoint.sh | 2 +-
pica-nginx/start.sh | 2 +-
postgres-backup/README.md | 46 +++++++++++++------------
postgres-backup/run.sh | 2 +-
28 files changed, 185 insertions(+), 135 deletions(-)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..d73c10e3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Picasoft's Dockerfiles
+
+Here is the list of `DockerFile`'s used by Picasoft to deploy and maintain its services.
+
+## Services
+
+### Mattermost
+ - [`mattermost`](./mattermost)
+ - [`mattermost-cleaner`](./mattermost-cleaner)
+ - [`mattermost-integration-giphy`](./mattermost-integration-giphy)
+
+### Etherpad
+ - [`pica-etherpad`](./pica-etherpad)
+
+### Kanban
+ - [`pica-kanboard`](./pica-kanboard)
+
+## Databases
+ - [`backup-rotation`](./backup-rotation)
+ - [`database`](./database)
+ - [`db-backup`](./db-backup)
+ - [`influxdb`](./influxdb)
+ - [`postgres-backup`](./postgres-backup)
+ - [`mysql-backup`](./mysql-backup)
+
+## Deployment & Misc (or to sort)
+ - [`docker-compose`](./docker-compose)
+ - [`pica-apache`](./pica-apache)
+ - [`pica-bot`](./pica-bot)
+ - [`pica-dokuwiki`](./pica-dokuwiki)
+ - [`pica-nginx`](./pica-nginx)
+ - [`checkmk`](./checkmk)
+ - [`debian`](./debian)
+ - [`framadate`](./framadate)
+ - [`galette`](./galette)
+ - [`grafana`](./grafana)
+ - [`minetest`](./minetest)
+ - [`nextcloud-docker`](./nextcloud-docker)
diff --git a/backup-rotation/README.md b/backup-rotation/README.md
index 2ee9a370..1f1a0faf 100644
--- a/backup-rotation/README.md
+++ b/backup-rotation/README.md
@@ -4,23 +4,23 @@ Le fichier backup_data.json recense les informations sur les différents service
## Structure
-* Nom du service : Contient une structure de données contenant les informations relatives au service telles qu'indiquées ci-dessous
-* "Host" : Indique l'hôte de la base de données
-* "Port" : Indique le port pour se connecter au service
-* "Database" : Indique le nom de la base de données
-* "Folder" : Indique le nom du dossier de backup utilisé par le script de backup et de rotation
-* "Cron" : Indique la fréquence de temps à laquelle les backups sont effectués par le script de rotation au format cron
-* "Backup-Rota" : Contient les paramètres pour la rotation des backups dans une structure de données comme indiqué ci-dessous
- * "Hour" : nombre de backups horaires à conserver
- * "Day" : nombre de backups quotidiens à conserver
- * "Week" : nombre de backups hebdomadaires à conserver
- * "Month": nombre de backups mensuels à conserver
+- Nom du service : Contient une structure de données contenant les informations relatives au service telles qu'indiquées ci-dessous
+- "Host" : Indique l'hôte de la base de données
+- "Port" : Indique le port pour se connecter au service
+- "Database" : Indique le nom de la base de données
+- "Folder" : Indique le nom du dossier de backup utilisé par le script de backup et de rotation
+- "Cron" : Indique la fréquence de temps à laquelle les backups sont effectués par le script de rotation au format cron
+- "Backup-Rota" : Contient les paramètres pour la rotation des backups dans une structure de données comme indiqué ci-dessous
+ - "Hour" : nombre de backups horaires à conserver
+ - "Day" : nombre de backups quotidiens à conserver
+ - "Week" : nombre de backups hebdomadaires à conserver
+ - "Month": nombre de backups mensuels à conserver
## Exemple
-```
+```json
{
- "wekan":
+ "wekan":
{
"Host": "wekan-db",
"Port": "27017",
@@ -60,10 +60,10 @@ Le fichier backup_data.json recense les informations sur les différents service
}
```
-##Exemple d'implémentation dans le docker-compose
+## Exemple d'implémentation dans le docker-compose
-```
+```yaml
##############################
####### Backup rotation ######
##############################
@@ -75,7 +75,6 @@ Le fichier backup_data.json recense les informations sur les différents service
- /DATA/CONFIG:/config
```
-
-* /DATA/BACKUP : Dossier contenant les backups à effecter
-* /DATA/CONFIG : Dossier contenant le fichier .json de données
-
+Avec :
+ - `/DATA/BACKUP` : Dossier contenant les backups à effecter
+ - `/DATA/CONFIG` : Dossier contenant le fichier .json de données
diff --git a/checkmk/README.md b/checkmk/README.md
index 3b18595f..63bc8631 100644
--- a/checkmk/README.md
+++ b/checkmk/README.md
@@ -1,6 +1,6 @@
# CheckMK
-Docker image for CheckMK monitoring system.
+Docker image for [CheckMK](https://mathias-kettner.com/) monitoring system.
## Configuration
This image need some environment variables to be set in order to work:
@@ -14,7 +14,7 @@ You can also add some optionnal variables to customize your container:
## Deploy
Here is a `docker-compose.yml` example to deploy CheckMK behind Traefik.
-```
+```yaml
checkmk:
image: registry.picasoft.net:5000/checkmk:1.4.0p19
container_name: checkmk
@@ -32,14 +32,14 @@ checkmk:
## Upgrade
CheckMK provide a tool to upgrade a site version. Unfortunately this tools need that both CheckMK versions (old and new one) are installed. This is something tricky when working with containers, so the upgrade process of an existing site is quite manual. First, enter in your current container (with `docker exec -it checkmk bash`), install new CheckMK version and run upgrade process.
-```
+```bash
# Replace 1.4.0p22 with the new version you want to use
NEW_CHECKMK_VERSION=1.4.0p22
# Get new version
-wget -O checkmk.deb "https://mathias-kettner.de/support/"$NEW_CHECKMK_VERSION"/check-mk-raw-"$NEW_CHECKMK_VERSION"_0.stretch_amd64.deb"
-dpkg -i checkmk.deb
+$ wget -O checkmk.deb "https://mathias-kettner.de/support/"$NEW_CHECKMK_VERSION"/check-mk-raw-"$NEW_CHECKMK_VERSION"_0.stretch_amd64.deb"
+$ dpkg -i checkmk.deb
# Upgrade the site
-omd stop $SITE_NAME
-omd update $SITE_NAME
+$ omd stop $SITE_NAME
+$ omd update $SITE_NAME
```
When everything is ok, you can exit and kill your container. Then build a new CheckMK image with the new version you want to use in your Dockerfile, and use this image to start again your CheckMK service. Your site will be working on the new CheckMK version.
diff --git a/database/Mongo/README b/database/Mongo/README
index 6f57b601..c2e6f111 100644
--- a/database/Mongo/README
+++ b/database/Mongo/README
@@ -1,5 +1,5 @@
Ce dockerfile permet de mettre un mot de passe sur la base Mongo via une variable d'environnement (contrairement au build officiel).
-Build le dockerfile puis créer le container grâce à runScript.sh
+Build le dockerfile puis créer le container grâce à `runScript.sh`
-Basé sur la version de tutumcloud (Github)
\ No newline at end of file
+Basé sur la version de tutumcloud (Github)
diff --git a/database/Mongo/run.sh b/database/Mongo/run.sh
index bcd9e0a7..37e48c22 100755
--- a/database/Mongo/run.sh
+++ b/database/Mongo/run.sh
@@ -1,4 +1,5 @@
-#!/bin/bash
+#!/usr/bin/env bash
+
set -m
mongodb_cmd="mongod --storageEngine $STORAGE_ENGINE"
diff --git a/database/Mongo/runScript.sh b/database/Mongo/runScript.sh
index 198bb0de..43aea7ec 100755
--- a/database/Mongo/runScript.sh
+++ b/database/Mongo/runScript.sh
@@ -1,3 +1,2 @@
-#!/bin/bash
-
+#!/usr/bin/env bash
docker run -v /root/mongo/data:/data/db -d --name mongoLatex -p 27017:27017 -p 28017:28017 -e MONGODB_USER="USERNAME" -e MONGODB_DATABASE="DBNAME" -e MONGODB_PASS="PASSWORD" dockerfile/mongodb
diff --git a/database/Mongo/set_mongodb_password.sh b/database/Mongo/set_mongodb_password.sh
index e70fd805..61fd20f5 100755
--- a/database/Mongo/set_mongodb_password.sh
+++ b/database/Mongo/set_mongodb_password.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
USER=${MONGODB_USER:-"admin"}
DATABASE=${MONGODB_DATABASE:-"admin"}
diff --git a/database/Redis/README b/database/Redis/README
index b71330b8..c2ff0f88 100644
--- a/database/Redis/README
+++ b/database/Redis/README
@@ -1 +1 @@
-Build then run runScript.sh
\ No newline at end of file
+Build then modify `runScript.sh` and run it.
diff --git a/database/Redis/runScript.sh b/database/Redis/runScript.sh
index 34bc276e..c181b4d9 100755
--- a/database/Redis/runScript.sh
+++ b/database/Redis/runScript.sh
@@ -1,2 +1,3 @@
+#!/usr/bin/env bash
docker pull redis
docker run -d -p 6379:6379 -v ~/PATH/TO/FOLDER:/data --name redis dockerfile/redis redis-server /etc/redis/redis.conf --requirepass PASSWORDHERE
diff --git a/db-backup/README.md b/db-backup/README.md
index 2ee9a370..54fabe79 100644
--- a/db-backup/README.md
+++ b/db-backup/README.md
@@ -4,23 +4,23 @@ Le fichier backup_data.json recense les informations sur les différents service
## Structure
-* Nom du service : Contient une structure de données contenant les informations relatives au service telles qu'indiquées ci-dessous
-* "Host" : Indique l'hôte de la base de données
-* "Port" : Indique le port pour se connecter au service
-* "Database" : Indique le nom de la base de données
-* "Folder" : Indique le nom du dossier de backup utilisé par le script de backup et de rotation
-* "Cron" : Indique la fréquence de temps à laquelle les backups sont effectués par le script de rotation au format cron
-* "Backup-Rota" : Contient les paramètres pour la rotation des backups dans une structure de données comme indiqué ci-dessous
- * "Hour" : nombre de backups horaires à conserver
- * "Day" : nombre de backups quotidiens à conserver
- * "Week" : nombre de backups hebdomadaires à conserver
- * "Month": nombre de backups mensuels à conserver
+ - Nom du service : Contient une structure de données contenant les informations relatives au service telles qu'indiquées ci-dessous
+ - "Host" : Indique l'hôte de la base de données
+ - "Port" : Indique le port pour se connecter au service
+ - "Database" : Indique le nom de la base de données
+ - "Folder" : Indique le nom du dossier de backup utilisé par le script de backup et de rotation
+ - "Cron" : Indique la fréquence de temps à laquelle les backups sont effectués par le script de rotation au format cron
+ - "Backup-Rota" : Contient les paramètres pour la rotation des backups dans une structure de données comme indiqué ci-dessous
+ - "Hour" : nombre de backups horaires à conserver
+ - "Day" : nombre de backups quotidiens à conserver
+ - "Week" : nombre de backups hebdomadaires à conserver
+ - "Month": nombre de backups mensuels à conserver
## Exemple
-```
+```json
{
- "wekan":
+ "wekan":
{
"Host": "wekan-db",
"Port": "27017",
@@ -60,10 +60,10 @@ Le fichier backup_data.json recense les informations sur les différents service
}
```
-##Exemple d'implémentation dans le docker-compose
+## Exemple d'implémentation dans le docker-compose
-```
+```yaml
##############################
####### Backup rotation ######
##############################
@@ -75,7 +75,6 @@ Le fichier backup_data.json recense les informations sur les différents service
- /DATA/CONFIG:/config
```
-
-* /DATA/BACKUP : Dossier contenant les backups à effecter
-* /DATA/CONFIG : Dossier contenant le fichier .json de données
-
+Avec:
+ - `/DATA/BACKUP` : Dossier contenant les backups à effecter
+ - `/DATA/CONFIG` : Dossier contenant le fichier .json de données
diff --git a/db-backup/mongo-run.sh b/db-backup/mongo-run.sh
index 96023aeb..b8a162c2 100755
--- a/db-backup/mongo-run.sh
+++ b/db-backup/mongo-run.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
# Antoine Barbare 18/02/18 <antoine@barbare.me>
BACKUP_FOLDER=${BACKUP_FOLDER:-"/backup/"}
diff --git a/db-backup/mysql-run.sh b/db-backup/mysql-run.sh
index 950feecd..21b85bf1 100755
--- a/db-backup/mysql-run.sh
+++ b/db-backup/mysql-run.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
if [ "${MYSQL_ENV_MYSQL_PASS}" == "**Random**" ]; then
unset MYSQL_ENV_MYSQL_PASS
diff --git a/db-backup/run.sh b/db-backup/run.sh
index 6a0f5860..4e77087c 100755
--- a/db-backup/run.sh
+++ b/db-backup/run.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
# DB_TYPE : MYSQL|POSTGRES
@@ -11,8 +11,8 @@
# MYSQL_DB_LIST POSTGRES_DB_LIST MONGO_DB_LIST
# MYSQL_INIT_BACKUP_LIST POSTGRES_INIT_BACKUP_LIST MONGO_INIT_BACKUP_LIST
# MYSQL_CRON_TIME_LIST POSTGRES_CRON_TIME_LIST MONGO_CRON_TIME_LIST
-# MYSQL_EXTRA_OPTS_LIST POSTGRES_EXTRA_OPTS-LIST MONGO_BACKUP_FOLDER_LIST
-# MYSQL_BACKUP_FOLDER_LIST POSTGRESQL_BACKUP_FOLDER_LIST
+# MYSQL_EXTRA_OPTS_LIST POSTGRES_EXTRA_OPTS-LIST MONGO_BACKUP_FOLDER_LIST
+# MYSQL_BACKUP_FOLDER_LIST POSTGRESQL_BACKUP_FOLDER_LIST
#####################
# Create the arrays #
diff --git a/framadate/README.md b/framadate/README.md
index 3753bef9..2c5fc389 100644
--- a/framadate/README.md
+++ b/framadate/README.md
@@ -6,7 +6,7 @@ Image Docker pour le déploiement de Framadate
## Configuration
### Base de données
Pour fonctionner, Framadate a besoin d'une base de données. Dans notre cas nous utilisons MySQL, que l'on déploie avec Docker. Afin que Framadate fonctionne correctement, nous devons désactiver le *SQL MODE* `NO_ZERO_DATE` de MySQL. On peut donc déployer une base de données pour Framadate ainsi (avec Docker Compose):
-```
+```yaml
framadate-db:
image: mysql:5.7
container_name: framadate-db
diff --git a/framadate/entrypoint.sh b/framadate/entrypoint.sh
index e5c41ef2..2e681867 100755
--- a/framadate/entrypoint.sh
+++ b/framadate/entrypoint.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
# Read environment variables or set default values
FRAMADATE_CONFIG=${FRAMADATE_CONFIG:-/var/www/framadate/app/inc/config.php}
diff --git a/grafana/README.md b/grafana/README.md
index 31628364..c36e9f5d 100644
--- a/grafana/README.md
+++ b/grafana/README.md
@@ -10,4 +10,8 @@ There are some evironment variable you can use to configure the instance :
- `GF_SECURITY_ADMIN_PASSWORD` : Admin password
## Data persistence
-In order to ensure data persistence for your Grafana datasources and dashboard, you should mount a volume on `/var/lib/grafana`. Because Grafana is not execute as root user, you need to specify correct access right to this volume. Is using bind mount, you should do something like `mkdir volumes/grafana && chown 472:472 volumes/grafana`.
+In order to ensure data persistence for your Grafana datasources and dashboard, you should mount a volume on `/var/lib/grafana`. Because Grafana is not execute as root user, you need to specify correct access right to this volume. If using bind mount, you should do something like:
+
+```bash
+$ mkdir volumes/grafana && chown 472:472 volumes/grafana
+```
diff --git a/mattermost-cleaner/README.md b/mattermost-cleaner/README.md
index fdddeb8a..1d25c9d0 100644
--- a/mattermost-cleaner/README.md
+++ b/mattermost-cleaner/README.md
@@ -1,16 +1,15 @@
# mattermost-cleaner
-This image runs a cron to delete automatic messages from Mattermost teams (alpha version, only run on one team).
-Delete command is run once when container starts and then every hour (depending on parameter) via cron.
+This image runs a `cron` to delete automatic messages from Mattermost teams (alpha version, only run on one team).
+Delete command is run once when container starts and then every hour (depending on parameter) via `cron`.
-**Warning** The commande delete directly data from database, which is bad pratice
-https://docs.mattermost.com/install/troubleshooting.html#important-notes
-https://docs.mattermost.com/deployment/on-boarding.html#do-not-manipulate-the-mattermost-database
+**Warning** The commande delete directly data from database, which is bad pratice ; see [here](https://docs.mattermost.com/install/troubleshooting.html#important-notes) and [there](https://docs.mattermost.com/deployment/on-boarding.html#do-not-manipulate-the-mattermost-database)
## Usage:
-docker run -d \
+```bash
+$ docker run -d \
--name mattermost-cleaner \
--env POSTGRES_HOST=mattermost-db \
--env POSTGRES_PORT=5432 \
@@ -21,18 +20,20 @@ docker run -d \
--net docker_default \
--link mattermost-db:mattermost-db \
registry.picasoft.net:5000/mattermost-cleaner:alpha
-
+```
## Parameters
-POSTGRES_HOST the name of the container
-POSTGRES_PORT the port number of the postgres database
-POSTGRES_USER the username of the postgres database
-POSTGRES_PASS the password of the postgres database
-POSTGRES_DB the name of the postgres database
-CRON_TIME the interval of cron job to run postgresdump. `0 * * * *` by default, which is every hour
+Here are the different parameters
+ - `POSTGRES_HOST` the name of the container
+ - `POSTGRES_PORT` the port number of the postgres database
+ - `POSTGRES_USER` the username of the postgres database
+ - `POSTGRES_PASS` the password of the postgres database
+ - `POSTGRES_DB` the name of the postgres database
+ - `CRON_TIME` the interval of cron job to run postgresdump. `0 * * * *` by default, which is every hour
## Docker-compose
+```yaml
version: "2"
services:
mattermost-cleaner:
@@ -47,3 +48,4 @@ services:
- POSTGRES_PASS=password
- POSTGRES_DB=mattermost
- MATTERMOST_TEAM=team
+```
diff --git a/mattermost-cleaner/cron.sh b/mattermost-cleaner/cron.sh
index 85dda8e0..0830d04b 100755
--- a/mattermost-cleaner/cron.sh
+++ b/mattermost-cleaner/cron.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
sh psqlcmd.sh
echo "${CRON_TIME} /psqlcmd.sh" > /crontab.conf
crontab /crontab.conf
diff --git a/mattermost-cleaner/psqlcmd.sh b/mattermost-cleaner/psqlcmd.sh
index fa3014db..6cbf330c 100755
--- a/mattermost-cleaner/psqlcmd.sh
+++ b/mattermost-cleaner/psqlcmd.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
[ -z "${POSTGRES_HOST}" ] && { echo "=> POSTGRES_HOST cannot be empty" && exit 1; }
[ -z "${POSTGRES_PORT}" ] && { echo "=> POSTGRES_PORT cannot be empty" && exit 1; }
diff --git a/minetest/README.md b/minetest/README.md
index 9a09176f..5af91de5 100644
--- a/minetest/README.md
+++ b/minetest/README.md
@@ -21,19 +21,18 @@ To set the log level of your container, you can use the `LOGLEVEL` environment v
Default (and recommended) level is 1.
## Install Framinetest pack Framasoft
-```
-cd /tmp
-wget https://framinetest.org/dl/worldmods.tar.gz https://framinetest.org/dl/textures.tar.gz
+```bash
+$ cd /tmp
+$ wget https://framinetest.org/dl/worldmods.tar.gz https://framinetest.org/dl/textures.tar.gz
-cd /PATH/TO/DATA/VOLUME/textures
-tar xvf /tmp/textures.tar.gz
+$ cd /PATH/TO/DATA/VOLUME/textures
+$ tar xvf /tmp/textures.tar.gz
-cd /PATH/TO/DATA/VOLUME/worlds
-mkdir myworldname
-cd myworldname
-tar xvf /tmp/worldmods.tar.gz
+$ cd /PATH/TO/DATA/VOLUME/worlds
+$ mkdir myworldname
+$ cd myworldname
+$ tar xvf /tmp/worldmods.tar.gz
```
## TODO
-- Support other backend ? (PostgreSQL ? => https://wiki.minetest.net/Database_backends/fr )
-
+- Support other backend ? (For PostgreSQL see [this](https://wiki.minetest.net/Database_backends/fr) ?)
diff --git a/minetest/entrypoint.sh b/minetest/entrypoint.sh
index ccb98487..a1002440 100755
--- a/minetest/entrypoint.sh
+++ b/minetest/entrypoint.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
# Check if there is a configurtion file
if [ ! -f /root/.minetest/minetest.conf ]
@@ -28,4 +28,3 @@ esac
# Run the server
/usr/games/minetestserver "$logoption" --gameid minetest --config /root/.minetest/minetest.conf
-
diff --git a/mysql-backup/README.md b/mysql-backup/README.md
index bf9e75f0..18f7a744 100644
--- a/mysql-backup/README.md
+++ b/mysql-backup/README.md
@@ -4,13 +4,15 @@ This image runs mysqldump to backup data using cronjob to folder `/backup`
## Usage:
- docker run -d \
- --env MYSQL_HOST=mysql.host \
- --env MYSQL_PORT=27017 \
- --env MYSQL_USER=admin \
- --env MYSQL_PASS=password \
- --volume host.folder:/backup
- tutum/mysql-backup
+```bash
+docker run -d \
+ --env MYSQL_HOST=mysql.host \
+ --env MYSQL_PORT=27017 \
+ --env MYSQL_USER=admin \
+ --env MYSQL_PASS=password \
+ --volume host.folder:/backup
+ tutum/mysql-backup
+```
Moreover, if you link `tutum/mysql-backup` to a mysql container(e.g. `tutum/mysql`) with an alias named mysql, this image will try to auto load the `host`, `port`, `user`, `pass` if possible.
@@ -19,23 +21,26 @@ Moreover, if you link `tutum/mysql-backup` to a mysql container(e.g. `tutum/mysq
## Parameters
- MYSQL_HOST the host/ip of your mysql database
- MYSQL_PORT the port number of your mysql database
- MYSQL_USER the username of your mysql database
- MYSQL_PASS the password of your mysql database
- MYSQL_DB the database name to dump. Default: `--all-databases`
- EXTRA_OPTS the extra options to pass to mysqldump command
- CRON_TIME the interval of cron job to run mysqldump. `0 0 * * *` by default, which is every day at 00:00
- MAX_BACKUPS the number of backups to keep. When reaching the limit, the old backup will be discarded. No limit by default
- INIT_BACKUP if set, create a backup when the container starts
- INIT_RESTORE_LATEST if set, restores latest backup
+Here are the parameters usable:
+ - `MYSQL_HOST` the host/ip of your mysql database
+ - `MYSQL_PORT` the port number of your mysql database
+ - `MYSQL_USER` the username of your mysql database
+ - `MYSQL_PASS` the password of your mysql database
+ - `MYSQL_DB` the database name to dump. Default: `--all-databases`
+ - `EXTRA_OPTS` the extra options to pass to mysqldump command
+ - `CRON_TIME` the interval of cron job to run mysqldump. `0 0 * * *` by default, which is every day at 00:00
+ - `MAX_BACKUPS` the number of backups to keep. When reaching the limit, the old backup will be discarded. No limit by default
+ - `INIT_BACKUP` if set, create a backup when the container starts
+ - `INIT_RESTORE_LATEST` if set, restores latest backup
## Restore from a backup
See the list of backups, you can run:
-
- docker exec tutum-backup ls /backup
+```bash
+docker exec tutum-backup ls /backup
+```
To restore database from a certain backup, simply run:
-
- docker exec tutum-backup /restore.sh /backup/2015.08.06.171901
+```bash
+docker exec tutum-backup /restore.sh /backup/2015.08.06.171901
+```
diff --git a/pica-apache/run.sh b/pica-apache/run.sh
index d0d447f6..64f96a3a 100644
--- a/pica-apache/run.sh
+++ b/pica-apache/run.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
chown www-data:www-data /app -R
if [ "$ALLOW_OVERRIDE" = "**False**" ]; then
diff --git a/pica-dokuwiki/run.sh b/pica-dokuwiki/run.sh
index 5433076a..288ea6c9 100755
--- a/pica-dokuwiki/run.sh
+++ b/pica-dokuwiki/run.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
# EXPLAINING THE SCRIPT run.sh
# This is a poor man's supervisord. The only thing this script does is watching its forked (background) processes and as soon as one dies, it terminates all the others and exits with the code of the first dying process.
diff --git a/pica-etherpad/entrypoint.sh b/pica-etherpad/entrypoint.sh
index 6d440b5c..a3ca9967 100644
--- a/pica-etherpad/entrypoint.sh
+++ b/pica-etherpad/entrypoint.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
set -e
if [ -z "$MYSQL_PORT_3306_TCP_ADDR" ]; then
diff --git a/pica-nginx/start.sh b/pica-nginx/start.sh
index 45b1bfc1..8b930f80 100755
--- a/pica-nginx/start.sh
+++ b/pica-nginx/start.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
set -e
diff --git a/postgres-backup/README.md b/postgres-backup/README.md
index ae7e4536..851ef159 100644
--- a/postgres-backup/README.md
+++ b/postgres-backup/README.md
@@ -3,33 +3,37 @@
This image runs postgresdump to backup data using cronjob to folder `/backup`
## Usage:
-
- docker run -d \
- --env POSTGRES_HOST=postgres.host \
- --env POSTGRES_PORT=27017 \
- --env POSTGRES_USER=admin \
- --env POSTGRES_PASS=password \
- --volume host.folder:/backup
- tutum/postgres-backup
-
+```bash
+docker run -d \
+ --env POSTGRES_HOST=postgres.host \
+ --env POSTGRES_PORT=27017 \
+ --env POSTGRES_USER=admin \
+ --env POSTGRES_PASS=password \
+ --volume host.folder:/backup
+ tutum/postgres-backup
+```
## Parameters
- POSTGRES_HOST the host/ip of your postgres database
- POSTGRES_PORT the port number of your postgres database
- POSTGRES_USER the username of your postgres database
- POSTGRES_PASS the password of your postgres database
- CRON_TIME the interval of cron job to run postgresdump. `0 0 * * *` by default, which is every day at 00:00
- POSTGRES_DB the DB to backup
- MAX_BACKUPS the number of backups to keep. When reaching the limit, the old backup will be discarded. No limit by default
- INIT_BACKUP if set, create a backup when the container starts
- INIT_RESTORE_LATEST if set, restores latest backup
+Here are the parameters:
+ - `POSTGRES_HOST` the host/ip of your postgres database
+ - `POSTGRES_PORT` the port number of your postgres database
+ - `POSTGRES_USER` the username of your postgres database
+ - `POSTGRES_PASS` the password of your postgres database
+ - `CRON_TIME` the interval of cron job to run postgresdump. `0 0 * * *` by default, which is every day at 00:00
+ - `POSTGRES_DB` the DB to backup
+ - `MAX_BACKUPS` the number of backups to keep. When reaching the limit, the old backup will be discarded. No limit by default
+ - `INIT_BACKUP` if set, create a backup when the container starts
+ - `INIT_RESTORE_LATEST` if set, restores latest backup
## Restore from a backup
See the list of backups, you can run:
- docker exec postgres-backup ls /backup
+```bash
+$ docker exec postgres-backup ls /backup
+```
To restore database from a certain backup, simply run:
-
- docker exec tutum-backup /restore.sh /backup/2015.08.06.171901
+```bash
+$ docker exec tutum-backup /restore.sh /backup/2015.08.06.171901
+```
diff --git a/postgres-backup/run.sh b/postgres-backup/run.sh
index 2fe57848..0cfde05d 100755
--- a/postgres-backup/run.sh
+++ b/postgres-backup/run.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
[ -z "${POSTGRES_HOST}" ] && { echo "=> POSTGRES_HOST cannot be empty" && exit 1; }
[ -z "${POSTGRES_PORT}" ] && { echo "=> POSTGRES_PORT cannot be empty" && exit 1; }
--
GitLab