> Flox is a self hosted Movie, Series and Animes watch list. It's build on top of Laravel and Vue.js and uses [The Movie Database](https://www.themoviedb.org/) API.
> The rating based on an 3-Point system for `good`, `medium` and `bad`.
> This image is available for arm64 and amd64. The right version for you system will automatically be pulled.
This container only exposes port 80/tcp. It is advised to run this configuration through a reverse proxy providing SSL if the service will be exposed over the internet. Data
is saved in the container at `/flox`.
To use the container you will need to set the env variable `tmdb_api_key` with your own [TheMovieDatabase API key](https://developers.themoviedb.org/3/getting-started/introduction). It is also recommended that you set `flox_admin_pass`. On first startup you also need to set `flox_db_init` to `true`.
In order to create an admin user you will need to run an initial migration. This can be done by running the container once with the environment variable `flox_db_init=true`.
If the env variables `flox_username` and `flox_password` are not set, the default login is: `admin:admin`.
You can then connect to [http://localhost](http://localhost) to access the application.
If you mounted the data directory, all changes will be saved through container recreation.
In the data directory is a file called `.lock`. This file controls whether or not to "reset" all application data. So don't remove the file unless you want to reset you installation.
The removed data will still be available in the running container in the directory `/tmp/flox` until you remove the container. After a reset you need to start the container with `flox_db_init=true` again.
| tmdb_api_key | str | **(required)** The TMDB API key to use - required for startup _(https://developers.themoviedb.org/3/getting-started/introduction)_ |
| flox_db_init | bool | **(required)** Run db initialization at container startup _(default: false)_ |
| flox_https | bool | If flox should use [https](https://github.com/devfake/flox/issues/148). Mostly used for reverse proxys with ssl termination _(default: false)_ |
| flox_app_url | str | The url you will be hosting the app on _(default: http://localhost)_ |
| flox_username | str | Inital username. Will not be overwritten after the initialization |
| flox_password | str | Initial password. Will not be overwritten after the initialization |
| flox_client_uri | str | The relative path you are hosting on _(default: /)_ |
| flox_timezone | str | The timezone flox is running in _(default: UTC)_ |
| flox_daily_reminder_time | str/int | The daily reminder time _(default: 10:00)_ |
| flox_weekly_reminder_time | str/int | The weekly reminder time _(default: 20:00)_ |
| puid | int | Unix user id to run the container as (default 4444) |
| pgid | int | Unix group id to run the container as (default 4444) |