https://github.com/samr1/docker-fittrackee
https://github.com/samr1/docker-fittrackee
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samr1/docker-fittrackee
- Owner: SamR1
- License: gpl-3.0
- Created: 2021-01-31T16:31:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T14:30:18.000Z (over 1 year ago)
- Last Synced: 2024-12-30T15:29:25.869Z (over 1 year ago)
- Language: Dockerfile
- Homepage:
- Size: 40 KB
- Stars: 13
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-fittrackee
> [!WARNING]
> This repository is no longer maintained. A docker image is now available, see FitTrackee [documentation](https://samr1.github.io/FitTrackee/en/installation.html) for more information.
Docker sample to install FitTrackee
---
[FitTrackee](https://samr1.github.io/FitTrackee/) is a self-hosted application, allowing you to track your outdoor activities (workouts) from gpx files and keep your data on your own server.
- To install **FitTrackee** with database initialisation and run the application:
```shell
$ git clone https://github.com/SamR1/docker-fittrackee.git
$ cd docker-fittrackee
$ $EDITOR db/create.sql # update fittrackee user password
$ cp .env.example .env
$ mkdir [FITTRACKEE_LOG_DIR] # create a directory to store fittrackee logs
$ $EDITOR .env # update environment variables (see Documentation)
$ make build up init
```
With default configuration (no `EMAIL_URL` set), email sending is disabled.
- Open http://localhost:5000 and register.
- To set admin rights to the newly created account, use the following command:
**Note**: it also activates account.
```bash
$ make set-admin USERNAME=
```
- To stop docker containers:
```bash
$ make stop
```
- To start docker containers:
```bash
$ make up
```
- To start **Fittrackee** application:
```bash
$ make run
```
- To start **Fittrackee** application and dramatiq workers (with Redis) in order to send emails:
```bash
$ make run-all
```
**Warning**: `EMAIL_URL` must be initialized.
- To update **FitTrackee**
```bash
$ make stop-all
$ make update migrate
$ make run-all # after checking update and migration went well
```
- To run shell inside **Fittrackee** container (with virtualenv):
```bash
$ make shell
```
Notes:
- **Important**: all uncommented [variables](https://samr1.github.io/FitTrackee/installation.html#environment-variables) present in .env must be initialized. Otherwise, the application may not start.
- If you just want to evaluate **FitTrackee**, ready to use docker files are available in **FitTrackee** repository (see [Documentation](https://samr1.github.io/FitTrackee/installation.html#docker)).
Troubleshooting:
- If installation or startup fails, check the environment variables.
- The commands can be run separately when debugging, for instance:
```shell
$ make build
$ make up
$ make migrate
$ make run
```
`make up` can be replaced with `docker-compose up` (without `detach` option to prevent containers from running in background and to display some errors).