From 2c969e7a81e054c49958acfd5a266e05d78f3cfb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Kucharczyk?= Date: Fri, 20 Jan 2023 16:27:01 +0000 Subject: [PATCH] Initial version --- Quickstart.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 Quickstart.md diff --git a/Quickstart.md b/Quickstart.md new file mode 100644 index 0000000..6a9e704 --- /dev/null +++ b/Quickstart.md @@ -0,0 +1,14 @@ +## Docker +### docker-compose +The easiest way to set up Timetracker is to use the provided [docker-compose.yml](https://git.kucharczyk.xyz/lukas/timetracker/src/branch/main/docker-compose.yml) file: + +```bash +git clone https://git.kucharczyk.xyz/lukas/timetracker.git +cd timetracker +docker-compose up -d +``` +Afterwards, the app will be available at `localhost:8000`. +### Container image +It is also possible to use a Docker image of Timetracker directly, either from my container registry at `registry.kucharczyk.xyz/timetracker` or by building the provided Dockerfile. +However in this scenario you need to have a way of serving static files served at the `/static` URL. +For an example of how this can be done, refer to the [docker-compose.yml](https://git.kucharczyk.xyz/lukas/timetracker/src/branch/main/docker-compose.yml) and [Caddyfile](https://git.kucharczyk.xyz/lukas/timetracker/src/branch/main/Caddyfile) \ No newline at end of file