Listy supports environment variables corresponding to the names in the `<>` in the example file above.
Listy supports environment variables corresponding to the names in the `<>` in the example file above.
### With Docker Compose
### With Docker compose
Listy can be deployed with Docker compose, and simply requires a MongoDB instance and the configuration file to work.
Listy can be deployed with Docker compose, and simply requires a MongoDB instance and the configuration file to work.
@ -66,6 +66,10 @@ Finally, run the following in the folder where your `docker-compose.yml` and `co
$ docker compose up -d
$ docker compose up -d
```
```
Now, follow the usage instructions above to register to Listy.
Listy's sync script is already configured to run in a 5 minute interval in the sample Docker compose. See more below on other ways to run it.
## `listy sync`
## `listy sync`
Besides the Go server (run with `listy server run`) the `sync` command provides most of the functionality in a self-contained worker that can either be run once or repeated by providing the `--repeat` flag which will be parsed by Go's [`time.ParseDuration()`](https://pkg.go.dev/time#ParseDuration) function. This will allow the sync script to run indefinitely.
Besides the Go server (run with `listy server run`) the `sync` command provides most of the functionality in a self-contained worker that can either be run once or repeated by providing the `--repeat` flag which will be parsed by Go's [`time.ParseDuration()`](https://pkg.go.dev/time#ParseDuration) function. This will allow the sync script to run indefinitely.
