Skip to content
Snippets Groups Projects
Commit 854a667b authored by Griefed's avatar Griefed :joystick:
Browse files

Cleanup README and add readme_variables

parent 743ce9d6
No related branches found
No related tags found
No related merge requests found
[![APP_NAME](https://i.griefed.de/images/2020/10/17/template.png)](https://github.com/ CREATOR_NAME / REPO_NAME)
[![Docker Pulls](https://img.shields.io/docker/pulls/griefed/
DOCKER_REPONAME
?style=flat-square)](https://hub.docker.com/repository/docker/griefed/
DOCKER_REPONAME
)
[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/
DOCKER_REPONAME
?label=Image%20size&sort=date&style=flat-square)](https://hub.docker.com/repository/docker/griefed/
DOCKER_REPONAME
)
[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/
DOCKER_REPONAME
?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/
DOCKER_REPONAME
)
[![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/
DOCKERREPONAME
?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/
DOCKER_REPONAME
)
[![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/
GITHUB_REPONAME
?label=GitHub%20Stars&style=social)](https://github.com/Griefed/
GITHUB_REPONAME
)
[![GitHub forks](https://img.shields.io/github/forks/Griefed/
GITHUB_REPONAME
?label=GitHub%20Forks&style=social)](https://github.com/Griefed/
GITHUB_REPONAME[![GITHUB_REPONAME](https://i.griefed.de/images/2020/10/17/template.png)](https://github.com/CREATOR_NAME/CREATOR_REPO)
[![Docker Pulls](https://img.shields.io/docker/pulls/griefed/DOCKER_REPONAME?style=flat-square)](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME)
[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/DOCKER_REPONAME?label=Image%20size&sort=date&style=flat-square)](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME)
[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/DOCKER_REPONAME?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME)
[![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/DOCKERREPONAME?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/DOCKER_REPONAME)
[![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/GITHUB_REPONAME?label=GitHub%20Stars&style=social)](https://github.com/Griefed/GITHUB_REPONAME)
[![GitHub forks](https://img.shields.io/github/forks/Griefed/GITHUB_REPONAME?label=GitHub%20Forks&style=social)](https://github.com/Griefed/GITHUB_REPONAME)
GITHUB_REPONAME
)
APP_NAME DESCRIPTION
DESCRIPTION
![APP_NAME]( EXAMPLE_IMAGE )
![GITHUB_REPONAME](EXAMPLE_IMAGE)
---
Creates a Container which runs [CREATOR_PROFILE](https://github.com/ CREATOR_PROFILE ) [APP_NAME](https://github.com/d-zone-org/ APP_NAME ), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on EXAMPLE_SITE_IF_EXISTS.
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
......@@ -49,9 +27,9 @@ Using this image allows us to use the same user/group ids in the container as on
```docker-compose.yml
version: '3.6'
services:
APP_NAME:
container_name: APP_NAME
image: griefed/APP_NAME
GITHUB_REPONAME:
container_name: GITHUB_REPONAME
image: griefed/GITHUB_REPONAME
restart: unless-stopped
volumes:
- ./path/to/config:/config
......@@ -91,7 +69,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
### Raspberry Pi & building the image yourself
Using the [Dockerfile]( LINK_TO_DOCKERFILE ), this container can be built and run on a Raspberry Pi.
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
......@@ -99,9 +77,9 @@ I've tested it on a Raspberry Pi 3B.
```docker-compose.yml
version: '3.6'
services:
APP_NAME:
container_name: APP_NAME
build: ./APP_NAME/
GITHUB_REPONAME:
container_name: GITHUB_REPONAME
build: ./GITHUB_REPONAME/
restart: unless-stopped
volumes:
- ./path/to/config/files:/config
......@@ -113,9 +91,9 @@ services:
- 80:80
```
1. Clone the repository: `git clone REPOSITORY_LINK ./APP_NAME`
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 APP_NAME`
1. `docker-compose up -d --build GITHUB_REPONAME`
1. Visit IP.ADDRESS.OF.HOST:80
1. ???
1. Profit!
GITHUB_REPONAME=
DOCKER_REPONAME=
CREATOR_NAME=
CREATOR_REPO=
EXAMPLE_IMAGE=
DESCRIPTION=
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment