Skip to content

hydazz/docker-lodestone

Repository files navigation

GitHub Release GitHub Package Repository Docker Hub Image Size Jenkins Build IG CI

Lodestone Don't use

lodestone

Supported Architectures

We use Docker manifest for cross-platform compatibility. More details can be found on Docker's website.

To obtain the appropriate image for your architecture, simply pull ghcr.io/imagegenius/lodestone:latest. Alternatively, you can also obtain specific architecture images by using tags.

This image supports the following architectures:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64

Version Tags

This image offers different versions via tags. Be cautious when using unstable or development tags, and read their descriptions carefully.

Tag Available Description
latest Latest Lodestone release with an Alpine Base

Application Setup

Here comes the sun

Usage

Example snippets to start creating a container:

Docker Compose

---
version: "2.1"
services:
  lodestone:
    image: ghcr.io/imagegenius/lodestone:latest
    container_name: lodestone
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Australia/Melbourne
    volumes:
      - path_to_appdata:/config
    ports:
      - 16662:16662
    restart: unless-stopped
docker run -d \
  --name=lodestone \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Australia/Melbourne \
  -p 16662:16662 \
  -v path_to_appdata:/config \
  --restart unless-stopped \
  ghcr.io/imagegenius/lodestone:latest

Container Variables

To configure the container, pass variables at runtime using the format <external>:<internal>. For instance, -p 8080:80 exposes port 80 inside the container, making it accessible outside the container via the host's IP on port 8080.

Variable Description
-p 16662 WebUI Port
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Australia/Melbourne Specify a timezone to use, eg. Australia/Melbourne
-v /config Appdata Path

Umask for running applications

All of our images allow overriding the default umask setting for services started within the containers using the optional -e UMASK=022 option. Note that umask works differently than chmod and subtracts permissions based on its value, not adding. For more information, please refer to the Wikipedia article on umask here.

User / Group Identifiers

To avoid permissions issues when using volumes (-v flags) between the host OS and the container, you can specify the user (PUID) and group (PGID). Make sure that the volume directories on the host are owned by the same user you specify, and the issues will disappear.

Example: PUID=1000 and PGID=1000. To find your PUID and PGID, run id user.

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Updating the Container

Most of our images are static, versioned, and require an image update and container recreation to update the app. We do not recommend or support updating apps inside the container. Check the Application Setup section for recommendations for the specific image.

Instructions for updating containers:

Via Docker Compose

  • Update all images: docker-compose pull
    • or update a single image: docker-compose pull lodestone
  • Let compose update all containers as necessary: docker-compose up -d
    • or update a single container: docker-compose up -d lodestone
  • You can also remove the old dangling images: docker image prune

Via Docker Run

  • Update the image: docker pull ghcr.io/imagegenius/lodestone:latest
  • Stop the running container: docker stop lodestone
  • Delete the container: docker rm lodestone
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images: docker image prune

Versions

  • 01.02.23: - Initial Commit.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published