diff --git a/wiki/docker-images/mariadb.md b/wiki/docker-images/mariadb.md index a75b06a..545904f 100644 --- a/wiki/docker-images/mariadb.md +++ b/wiki/docker-images/mariadb.md @@ -2,7 +2,7 @@ The official container and documentation was made by [mariadb](https://hub.docker.com/_/mariadb). The Docker container is mainly used in combination with other containers. -To achieve this in the easiest way use a docker-compose file +To achieve this in the easiest way use a docker-compose file. ## Environment-variables diff --git a/wiki/docker-images/redis.md b/wiki/docker-images/redis.md new file mode 100644 index 0000000..2d79af9 --- /dev/null +++ b/wiki/docker-images/redis.md @@ -0,0 +1,13 @@ +# redis + +The official container and documentation was made by [redis](https://hub.docker.com/_/redis). +The Docker container is mainly used in combination with other containers. +To achieve this in the easiest way use a docker-compose file. + +## Volumes + +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ----------- | --------------- | -------------------- | +| `redis` | `/data` | storage for all data | diff --git a/wiki/docker-images/wallabag_-_wallabag.md b/wiki/docker-images/wallabag_-_wallabag.md new file mode 100644 index 0000000..00804e4 --- /dev/null +++ b/wiki/docker-images/wallabag_-_wallabag.md @@ -0,0 +1,105 @@ +# wallabag - wallabag + +The Server consists of 3 Docker containers, one is the wallabag main server, one +is a database and one a redis instance. +In addition to the main container you need to connect a [mariadb container](./mariadb.md) +and a [redis container](./redis.md) to it. + +## Environment-variables + +Set the following environment-variables in the `environment:` section of the +docker-compose file. + +| Name | Usage | Default | +| --------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `MYSQL_ROOT_PASSWORD` | Password for the mySQL root user | | +| `SYMFONY__ENV__DATABASE_DRIVER` | Database driver to use | `pdo_sqlite` | +| `SYMFONY__ENV__DATABASE_HOST` | Host for database | `127.0.0.1` | +| `SYMFONY__ENV__DATABASE_PORT` | Port for database | | +| `SYMFONY__ENV__DATABASE_NAME` | Name for database | `symfony` | +| `SYMFONY__ENV__DATABASE_USER` | User for database | `root` | +| `SYMFONY__ENV__DATABASE_PASSWORD` | Password for database | `~` | +| `SYMFONY__ENV__DATABASE_CHARSET` | Character set to be used by the database | `utf8` | +| `SYMFONY__ENV__MAILER_HOST` | SMTP host | `127.0.0.1` | +| `SYMFONY__ENV__MAILER_USER` | SMTP user | `~` | +| `SYMFONY__ENV__MAILER_PASSWORD` | SMTP passwort | `~` | +| `SYMFONY__ENV__FROM_EMAIL` | mail address used for outgoing mails | `wallabag@example.com` | +| `SYMFONY__ENV__DOMAIN_NAME` | URL to wallabag instance | `https://your-wallabag-url-instance.com` | +| `SYMFONY__ENV__SERVER_NAME` | Name for the wallabag server | `Your wallabag instance` | + +## Volumes + +Set the following volumes in the `volumes:` section of the docker-compose file. + +| Volume-Name | Container mount | Description | +| ------------------- | ------------------------------------- | -------------------------------- | +| `wallabag_wallabag` | `/var/www/wallabag/web/assets/images` | storage for wallabag config data | + +## Ports + +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| `80` | `80` | TCP | WebUI | + +## Rebuild + +```shell +#!/bin/sh +docker-compose down +docker pull wallabag/wallabag:latest +docker pull mariadb:latest +docker pull redis:alpine +docker-compose up -d +``` + +## Docker-Compose.yml + +```yml +version: '3' +services: + wallabag: + image: wallabag/wallabag + environment: + - MYSQL_ROOT_PASSWORD=wallaroot + - SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql + - SYMFONY__ENV__DATABASE_HOST=db + - SYMFONY__ENV__DATABASE_PORT=3306 + - SYMFONY__ENV__DATABASE_NAME=wallabag + - SYMFONY__ENV__DATABASE_USER=wallabag + - SYMFONY__ENV__DATABASE_PASSWORD=wallapass + - SYMFONY__ENV__DATABASE_CHARSET=utf8mb4 + - SYMFONY__ENV__MAILER_HOST=127.0.0.1 + - SYMFONY__ENV__MAILER_USER=~ + - SYMFONY__ENV__MAILER_PASSWORD=~ + - SYMFONY__ENV__FROM_EMAIL=wallabag@example.com + - SYMFONY__ENV__DOMAIN_NAME=http://bag.home.server + - SYMFONY__ENV__SERVER_NAME="Your wallabag instance" + ports: + - "8082:80" + volumes: + - wallabag_wallabag:/var/www/wallabag/web/assets/images + db: + image: mariadb + environment: + - MYSQL_ROOT_PASSWORD=wallaroot + volumes: + - /opt/wallabag/data:/var/lib/mysql + db: + image: mariadb + environment: + - MYSQL_ROOT_PASSWORD=wallaroot + volumes: + - /opt/wallabag/data:/var/lib/mysql + redis: + image: redis:alpine + volumes: + - wallabag_redis:/data + +volumes: + wallabag_wallabag: + driver: local + wallabag_redis: + driver: local +``` diff --git a/wiki/recommended_alternatives.md b/wiki/recommended_alternatives.md index 1d15b51..d7ce222 100644 --- a/wiki/recommended_alternatives.md +++ b/wiki/recommended_alternatives.md @@ -17,6 +17,9 @@ recommended, good software (mostly free and/or open-source). - [LibreOffice](https://www.libreoffice.org/) is a free and open-source office software suite. +- [**Pocket**](https://getpocket.com/) alternatives: + - [wallabag](./wallabag.md) is a self-hosted application for saving websites. + - **Preinstalled Android apps** alternatives: - [SimpleMobileTools](https://www.simplemobiletools.com/) features a wide variety of apps, that can replace the preinstalled apps (calendar, gallery, launcher, etc.). diff --git a/wiki/wallabag.md b/wiki/wallabag.md new file mode 100644 index 0000000..bfc9617 --- /dev/null +++ b/wiki/wallabag.md @@ -0,0 +1,7 @@ +# Wallabag + +[Wallabag](https://github.com/wallabag/wallabag) is a read-it-later app. + +## Server + +A server can be setup via docker with the [wallabag image](./docker-images/wallabag_-_wallabag.md).