mirror of
https://github.com/Bubka/2FAuth.git
synced 2024-11-08 09:24:59 +01:00
.. | ||
docker-compose.yml | ||
entrypoint.sh | ||
nginx.conf | ||
README.md |
Docker
You can run 2fauth in a single Docker container.
Features
Setup
-
Create a directory on your host
2fauth
:mkdir 2fauth
-
If your host is not Windows: since the container runs without root as user
www-data
(uid=33(www-data) gid=33(www-data) groups=33(www-data)
), you need to fix the ownership and permissions of that directory:chown 33:33 2fauth chmod 700 2fauth
-
Run the container interactively:
docker run -it --rm -p 8000:8000/tcp \ -v /yourpath/2fauth:/2fauth 2fauth/2fauth
-
Access it at http://localhost:8000
You can stop it with CTRL+C
.
- You can also run it in the background by replacing
-it --rm
with-d
. - You can set environment variables available (see the .env.example) with
-e
, for example-e APP_NAME=2FAuth
. - You can also use the docker-compose.yml with
docker-compose
and modify it as you wish.
Use an existing SQLite file
If you already have an SQLite file, move it to /yourpath/2fauth/database.sqlite
on your host before starting the container. Don't forget to fix its ownership and permissions if you run on *nix:
chown 33:33 /yourpath/2fauth/database.sqlite
chmod 700 /yourpath/2fauth/database.sqlite
The container will automagically pick it up.
Implementation details
- The container is based on
debian:buster-slim
- The container runs an Nginx server together with PHP-FPM as a system service.
- The
/srv
directory holds the repository data and PHP code. - The
/2fauth
directory is targeted for the container end users. - By default the container logs the Nginx logs and the PHP-FPM logs. The application logs can be found in
/2fauth/storage/logs
.
TODOs
- Write short commit hash to installed file to only migrate on commit change
- Base image (or other image) on Alpine.
- Setup CI to build image on push to master
- Change Dockerfile and CI to cross build for all architectures.