diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 794ffe1e1..652791349 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -2,7 +2,7 @@ name: Publish Docker image on: push: - branches: [master, develop, docker**] + branches: [master, develop] release: types: [published, created, edited] diff --git a/Docker/docker-compose.yml b/Docker/docker-compose.yml index 0574e7735..0eb5bd839 100644 --- a/Docker/docker-compose.yml +++ b/Docker/docker-compose.yml @@ -13,4 +13,7 @@ services: - ../Data-Storage:/app/Data-Storage - ../Log-Files:/app/Log-Files - ../My-Workspaces:/app/My-Workspaces + environment: + - PUID: '1000' + - GUID: '1000' restart: on-failure diff --git a/README.md b/README.md index d796adf8f..0fe335819 100644 --- a/README.md +++ b/README.md @@ -373,8 +373,23 @@ When you're done just exec `docker kill superalgos` Follow the link to [install docker-compose](https://docs.docker.com/compose/install/) -Run `docker-compose -f Docker/docker-compose.yml up` +Run `docker-compose -f Docker/docker-compose.yml up`. +## Configure the Container Environment + +### Available image tags + +To avoid breaking changes, the `shasum hash` and the `release` tags are the best to use. These will generally ensure you are always running the same code. The other tags will change which code they are pointing to more frequently and without notice. + +- `latest` : the absolute latest build +- `master` : the latest master branch build +- `develop` : the latest develop branch build +- `` : a specific git commit hash +- `` : corresponds with a Github Release (git tag), i.e. `beta-10` + +### Environment variables + +`PUID` and `GUID` environment variables can be used to help avoid permissions issues in the mounted volumes between the container environment and the local OS environment. The default `PUID` and `GUID` is `1000`. You can view the current user's PUID and GUID with the `id` command. # What is Superalgos?