diff --git a/README.md b/README.md index 521e5d7..e54b75a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # WorkTimer -WorkTimer +WorkTimer Time tracking app built with Remix, supports authentication, projects management, and monthly or custom reports. @@ -15,6 +15,7 @@ Built for self-hosting: host it anywhere you want, and use it for free. Your tim - [Tech stack](#tech-stack) - [Running locally](#running-locally) - [Running with Docker](#running-with-docker) + - [Multi-platform docker image](#multi-platform-docker-image) - [Screenshots](#screenshots) - [License](#license) @@ -45,6 +46,22 @@ If you want to use different defaults, you can build your own image. See [Runnin ### Docker compose +Basic example: + +```yaml +version: '3.8' + +services: + work-timer: + image: nzambello/work-timer + container_name: work-timer + restart: always + ports: + - 8080:8080 + volumes: + - ./dockerData/work-timer:/data # Path to data for DB persistence +``` + Example of docker-compose.yml with [Traefik](https://traefik.io/) as reverse proxy: ```yaml @@ -112,28 +129,35 @@ docker built -t work-timer . docker run -p 127.0.0.1:8080:8080 work-timer ``` +### Multi-platform Docker image + +```bash +docker buildx create --name mybuilder --driver docker-container --bootstrap --use # create a new builder and switch to it using a single command. +docker buildx build --platform linux/amd64,linux/arm64 -t nzambello/work-timer:latest --push . +``` + ## Screenshots ### Light / Dark mode - - + + ### Time tracking - + ### Projects - - + + ### Reports - + ## License [Nicola Zambello](https://github.com/nzambello) © 2023 -[GNU GPLv3](./LICENSE) +[GNU GPLv3](https://github.com/nzambello/work-timer/raw/main/LICENSE)