diff --git a/.readme_template b/.readme_template deleted file mode 100644 index 7d863f0ea63225ce23042b50e4c8a6981c71cdd8..0000000000000000000000000000000000000000 --- a/.readme_template +++ /dev/null @@ -1,99 +0,0 @@ -GITHUB_REPONAME[](https://github.com/CREATOR_NAME/CREATOR_REPO) - -[](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME) -[](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME) -[](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME) -[](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME) -[](https://github.com/Griefed/GITHUB_REPONAME) -[](https://github.com/Griefed/GITHUB_REPONAME) - -GITHUB_REPONAME - -DESCRIPTION - - - ---- - -Creates a Container which runs [CREATOR_NAME's](https://github.com/CREATOR_NAME) [CREATOR_REPO](https://github.com/CREATOR_NAME/CREATOR_REPO), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on EXAMPLE_SITE_IF_EXISTS. - -The lasiobase/alpine image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay). -Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier - -## Deployment - -### Pre-built images - -```docker-compose.yml -version: '3.6' -services: - GITHUB_REPONAME: - container_name: GITHUB_REPONAME - image: griefed/GITHUB_REPONAME - restart: unless-stopped - volumes: - - ./path/to/config:/config - - ./path/to/data:/data - environment: - - TZ=Europe/Berlin - - PUID=1000 # User ID - - PGID=1000 # Group ID - ports: - - 80:80 -``` - -## Configuration - -Configuration | Explanation ------------- | ------------- -[Restart policy](https://docs.docker.com/compose/compose-file/#restart) | "no", always, on-failure, unless-stopped -config volume | Contains config files and logs. -data volume | Contains your/the containers important data. -TZ | Timezone -PUID | for UserID -PGID | for GroupID -ports | The port where the service will be available at. - -## User / Group Identifiers - -When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids this issue by allowing you to specify the user `PUID` and group `PGID`. - -Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. - -In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: - -``` - $ id username - uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) -``` - -### Raspberry Pi & building the image yourself - -Using the [Dockerfile](https://github.com/Griefed/GITHUB_REPONAME/Dockerfile), this container can be built and run on a Raspberry Pi. -I've tested it on a Raspberry Pi 3B. - -#### docker-compose.yml - -```docker-compose.yml -version: '3.6' -services: - GITHUB_REPONAME: - container_name: GITHUB_REPONAME - build: ./GITHUB_REPONAME/ - restart: unless-stopped - volumes: - - ./path/to/config/files:/config - environment: - - TZ=Europe/Berlin - - PUID=1000 # User ID - - PGID=1000 # Group ID - ports: - - 80:80 -``` - -1. Clone the repository: `git clone https://github.com/Griefed/GITHUB_REPONAME.git ./GITHUB_REPONAME` -1. Prepare docker-compose.yml file as seen above -1. `docker-compose up -d --build GITHUB_REPONAME` -1. Visit IP.ADDRESS.OF.HOST:80 -1. ??? -1. Profit!