diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b95ee354443791970c388200a4a77a8ac4c34bdb..6c4703e01ace4cdf6283d9bd77ab1c33a20fc721 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,13 +1,14 @@ stages: - - readme - - build + - readme + - build + - publish image: docker:19.03.8 readme: stage: readme image: alpine:3.12 - script: + script: - apk add gettext - source .gitlab/.readme_variables - echo "" @@ -24,6 +25,8 @@ readme: - echo $EXAMPLE_SITE_LINK - echo $EXAMPLE_IMAGE_LINK - echo $CONTAINER_PORT + - echo $CONTAINER_PORT2 + - echo $BASE_IMAGE - echo "" - echo "" - envsubst < .gitlab/readme_template | less @@ -34,6 +37,13 @@ build: script: - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY - docker pull $CI_REGISTRY_IMAGE:latest || true - - docker build --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA --tag $CI_REGISTRY_IMAGE:latest . - - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA + - docker build --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:latest . - docker push $CI_REGISTRY_IMAGE:latest +publish: + stage: publish + script: + - docker login -u $DOCKER_USER -p $DOCKER_PASSWORD $DOCKER_REGISTRY + - docker build --tag $DOCKER_USER/$DOCKER_REPO:arm . + - docker push $DOCKER_USER/$DOCKER_REPO:arm + - docker system prune --all --force + diff --git a/.gitlab/.readme_variables b/.gitlab/.readme_variables index a12a6aa216336655eecc2849ec524d74196597af..8094848885b1c4b0e0d67879f1a7baf4ad1068d1 100644 --- a/.gitlab/.readme_variables +++ b/.gitlab/.readme_variables @@ -1,4 +1,3 @@ -export LOGO_IMAGE_LINK='https://www.example.com/example.png' export GITHUB_REPONAME='docker-template-repo' export GITHUB_USERNAME='username' export DOCKERHUB_REPONAME='template-repo' @@ -8,5 +7,4 @@ export DESCRIPTION='This is an example description for the docker-template-repo. export CREATOR_USERNAME='Griefed' export CREATOR_REPONAME='template' export EXAMPLE_SITE_LINK='https://www.example.com' -export EXAMPLE_IMAGE_LINK='https://www.example.com/screenshot.png' export CONTAINER_PORT='1234' diff --git a/.gitlab/readme_template b/.gitlab/readme_template index c41bbb7beb90667f4d105ebc50098a5a7744a4e6..4b74c9dae6aeb83c13d813b2e2d349485f55b938 100644 --- a/.gitlab/readme_template +++ b/.gitlab/readme_template @@ -1,9 +1,11 @@ -[](https://github.com/$CREATOR_NAME/$CREATOR_REPO) +[](https://github.com/$CREATOR_USERNAME/$CREATOR_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://hub.docker.com/repository/docker/griefed/$DOCKER_REPONAME) +--- + +[](https://hub.docker.com/repository/docker/griefed/$DOCKERHUB_REPONAME) +[](https://hub.docker.com/repository/docker/griefed/$DOCKERHUB_REPONAME) +[](https://hub.docker.com/repository/docker/griefed/$DOCKERHUB_REPONAME) +[](https://hub.docker.com/repository/docker/griefed/$DOCKERHUB_REPONAME) [](https://github.com/Griefed/$GITHUB_REPONAME) [](https://github.com/Griefed/$GITHUB_REPONAME) @@ -11,13 +13,13 @@ $GITHUB_REPONAME $DESCRIPTION -[](https://github.com/$CREATOR_NAME/$CREATOR_REPO) +[](https://github.com/$CREATOR_USERNAME/$CREATOR_REPONAME) --- -Creates a Container which runs [CREATOR_USERNAME's](https://github.com/$CREATOR_USERNAME) [$CREATOR_REPONAME](https://github.com/$CREATOR_USERNAME/$CREATOR_REPONAME), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on $EXAMPLE_SITE_LINK. +Creates a Container which runs [$CREATOR_USERNAME's](https://github.com/$CREATOR_USERNAME) [$CREATOR_REPONAME](https://github.com/$CREATOR_USERNAME/$CREATOR_REPONAME), with [lsiobase/$BASE_IMAGE](https://hub.docker.com/r/lsiobase/$BASE_IMAGE) as the base image, as seen on $EXAMPLE_SITE_LINK. -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). +The lasiobase/$BASE_IMAGE 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 @@ -27,21 +29,27 @@ Using this image allows us to use the same user/group ids in the container as on ```docker-compose.yml version: '3.6' services: - $GITHUB_REPONAME: - container_name: $GITHUB_REPONAME - image: griefed/$GITHUB_REPONAME + $DOCKERHUB_REPONAME: + container_name: $DOCKERHUB_REPONAME + image: griefed/$DOCKERHUB_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: - - 8080:$COTNAINER_PORT + - 80:$CONTAINER_PORT + - $CONTAINER_PORT2 ``` +## Raspberry Pi + +To run this container on a Raspberry Pi, use the `arm`-tag. I've tested it on a Raspberry Pi 3B. + +`griefed/$DOCKERHUB_REPONAME:arm` + ## Configuration Configuration | Explanation @@ -67,34 +75,33 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -### Raspberry Pi & building the image yourself +### 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. +Use the [Dockerfile](https://github.com/Griefed/$GITHUB_REPONAME/Dockerfile) to build the image yourself, in case you want to make any changes to it #### docker-compose.yml ```docker-compose.yml version: '3.6' services: - $GITHUB_REPONAME: - container_name: $GITHUB_REPONAME + $DOCKERHUB_REPONAME: + container_name: $DOCKERHUB_REPONAME build: ./$GITHUB_REPONAME/ restart: unless-stopped volumes: - ./path/to/config/files:/config - - ./path/to/data:/data environment: - TZ=Europe/Berlin - PUID=1000 # User ID - PGID=1000 # Group ID ports: - 8080:$CONTAINER_PORT + - $CONTAINER_PORT2 ``` 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. `docker-compose up -d --build $DOCKERHUB_REPONAME` 1. Visit IP.ADDRESS.OF.HOST:8080 1. ??? 1. Profit! diff --git a/README.md b/README.md index 8494792cdf753d93293fc8f2eab1ff9cbca46172..4eb576a2683b2859d2049c25ac472ba99afeb3dc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[](https://github.com/d-zone-org/d-zone) +[](https://github.com/d-zone-org/d-zone) [](https://hub.docker.com/repository/docker/griefed/d-zone) [](https://hub.docker.com/repository/docker/griefed/d-zone) @@ -11,7 +11,7 @@ D-Zone is a graphical simulation meant to abstractly represent the activity in y This is not meant for any actual monitoring or diagnostics, only an experiment in the abstraction of chatroom data represented via autonomous characters in a scene. - +[](https://github.com/d-zone-org/d-zone) --- diff --git a/img/docker-D-Zone_header.png b/img/docker-D-Zone_header.png new file mode 100644 index 0000000000000000000000000000000000000000..4efb025b80450a33846d08dcd48d391e32fa0974 Binary files /dev/null and b/img/docker-D-Zone_header.png differ diff --git a/img/docker-D-Zone_icon.png b/img/docker-D-Zone_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..b8421fcf597f2a0be39e139575d57f9ebd5d8251 Binary files /dev/null and b/img/docker-D-Zone_icon.png differ diff --git a/img/docker-D-Zone_screenshot.png b/img/docker-D-Zone_screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..6eab99fc00692d0254525838b3b8f9fdca2295d4 Binary files /dev/null and b/img/docker-D-Zone_screenshot.png differ