Docker

The recommended installation method is with Docker.

docker-compose

Pre-requisite: You have either docker-compose or Docker Desktop installed

1. Create a directory ambientweather-local-server
   1. Inside this folder create a docker-compose.yaml file in the directory
   2. Also create a configuration.local.json file in the directory.
2. Open a terminal in this folder
3. Run: docker-compose pull && docker-compose up -d

You can learn more about customizing your configuration over in the Configuration Section

To stop the server

1. You can use Docker Desktop application to kill the containers
2. Or, you can open a terminal in the ambientweather-local-server folder
   1. Run: docker-compose down

To update the server

1. Open a terminal in the ambientweather-local-server folder
   1. Run: docker-compose pull && docker-compose up -d

Repositories

DockerHub

docker run -v /full/path/to/configuration.local.json:/app/configuration.local.json -v /full/path/to/output:/app/output philosowaffle/ambientweather-local-server:stable

GitHub Package

docker run -v /full/path/to/configuration.local.json:/app/configuration.local.json -v /full/path/to/output:/app/output ghcr.io/philosowaffle/ambientweather-local-server:stable

Tags

1. stable - Always points to the latest release
2. latest - The bleeding edge of the master branch, breaking changes may happen
3. vX.Y.Z - For using a specific released version

Docker User

The images run the process under the user and group awuser:awuser with uid and gid 1017:1017. To access files created by awuser:

1. Create a group on the local machine awuser with group id 1017
2. Add your user on the local machine to the awuser group