Skip to content
Snippets Groups Projects
README.md 11.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • Griefed's avatar
    Griefed committed
    [![TEMPLATE](GRIEFED_GITHUB_REPO_IMAGE)](GRIEFED_GITHUB_REPO)
    
    Griefed's avatar
    Griefed committed
    
    [![Homepage](https://img.shields.io/badge/Griefed.de-Homepage-c0ffee?style=for-the-badge&labelColor=325358&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAACylBMVEUAAAD////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////9/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f39/f3+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v6OsnIvAAAA7XRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFhcYGRobHB0eHyAhIiQlJicoKSorLC0uLzAxMjU2Nzg5Ojs8Pj9AQUJERUZHSElLTE9QUVJTVFVWV1hZXF1eX2BhYmNkZWZnaGlqa2xtbm9wcXJzdHV2d3h5ent8fX5/gIGCg4SGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6Cio6WmqKmqq6ytrrCxsrO0tba3uLm6u7y9vr/AwcLDxMXGx8jKy8zNzs/Q0dLT1NXW2Nrb3N3e3+Dh4uPk5ebn6Onq6+zt7u/w8fLz9PX29/j5+vv8/f4O/wLaAAAGUklEQVR42o3WBVsb2xoF4G9PQqgXubktUnd3d3fFqjjHQt2Vg9Xd3TXU3d1b3KEugczM+g8nY5VAmrxYZGaxtj1A9jgfcoS1SdKTUx73gg2kYZzOTcdIYQjKeVWZnPJ7a91bh2zc6/SJWbNj16F9G+aNa12VkXGjBYU+5FTTz0DqmPphB9MsIjRCgXnRXRH42pSc6lQCgLdCIYoifsL3IqcG8FB8e34sISpkUnjUjKRj2VpeIDmjmweFdYeRkcr/mtYjK9CNfstnt1pAyFxmJA3XIi5VUDucqEeOsV5p6u2v5tbl6Cecb9RtC2T5Qxk5wE35rN5u8uPKhHuMPPZB/FgClEzXUbl0s3jg6S3+Ubgnlati1w1XB74ExPhyJ4KbzQNHasQHVyeHdH56nxQpoZwOLIyHuLkC6ciJSrtEiNMZ2ev3BdjgTi6ouAsoGUJ2amUCh9zJJZVSgHy71XQ7CDzwJhf5vQRO/DqR4wR87qYn1+gS7gHi0gGdmvp5cKSv4tOsd1A68PaaH7loAg8bvuTz23s+lPS66BsvAhDX66rWlDlt4vEYitIgojbZULzvwqSH/OOPy8iZCBGyPQYiFmSB7GgFBpuNNPrtWfOZW2bzlcvmlFtnzGdvms3XLppTbqeYz18/15YkXq8heVObbAwb5DjLCJID4qjfmTBDyNTuxpi/vHtOCTGEhrarE/FX1cGTR1eMiuxxsTVJYgWp7GiSGe/A5rYHMVy68eGU35wddXc3o/EJ7u4rxlKLXXVYxHx91Y0DqNv2/7E5C5QOflIFoSkpZktPIhkxPMzNB7AzpHdYjcjh3XsOifl/aO+QOlPHtRs84E/vqL6jmwZP6HFO6sDNlyr8STJ2GECqLxHDLTmgcINpxZNZplPHTbOeJps23ZlhOn/AtOD5UtOua7GxZxMfMCKql8UDpxhJKmdCFOI4Iia+KCoGYO5rZ/qGn591Ihtu+V4euVVJ0qwUqZdakM3UE6mb41Lj2pOdfn9TGcYa6bC2JMkwEfv8dSQJmBDtYSZyJYDYGWAUSf4BlpAiIMJ/4R0XA2g1MJMkiUCUFrCs34bnrgaYgLVyle0QA7SAwMAGZlcDJgC75YC9EMdqAXcXBDxyNWA8cJBsdCeBUC1gZijnuIFnTVVFkgQAR8iGOwxEawHjfUPPkL1mJ+/0JKKW36C6TpIQYA9JtgLztYB1AcnvyE717LeFX5sT9YMmlyR/qZNIC4Et3xs0DCjToGeSu25KZNmARO0XBwKXOTVgaQAzk53aNYn07ewDdLWOAQEkac8jx9+oBFyOL2cVmPxJjd6LqtPSjFzOBt9emdwi8IeXccoQRraxazDYpAqqvnqnagoRFy8ARZ4k4S4AQmY9ZRlbL3hFP2Ol0ERDk0PklwbgPEeymQCEeZwUMKNt/INfA/DdPz/NAYsW8OMItRYBvPKTAoKm+JpdCfC4A5s7RpKNldKEWCng2Sy7SWQiNFHQZNAoC2zE9QayqZMKyStPooA/ovVyA6Yh0w5VfOWl2sNhFY9DZglkRIZ9kAnh0ip4RF8gonioSgc9hKpggADVo24foMhuQxRiheJxdWkrrywmohS7gds9zN8oAhD5r4WvEsnn3tvPJcofyxBbg7bDU5wHfLr2EcgO7NnUp7KeuOq+TTr2TxCB+/G6gFUjmAsBeUNKIQTSz9wvAGm1KeDE2vHSKqyHih/5GqqPnZ/nqi6mAUfc6BdN3gKXqgSMH9DNTETBO1RrqoZrDxdzpKpyGciuTXbGWYGDocv7xWcQUS40fQRompOi0gHg2wCyxy0EkBXhP/cWEeVD0w/ftSIbHVXeBwjRjMrQrxOBq9OMV3SOAzwmJPifBwR1OHbc1wJIH5q2sWvFcofQwivyCX/3NSAu0VO59AutgNUifji2f+O/cbL5VYLiFPHJM16LkFj+5sgBbtxbyCx3on79f52rP/+12iVvMCPHGp8TIRNS/22hI40xLku9XTxel37LMDUPCvGKP6k4n708FEvdyJlgEYqis2tmhE+dGDZr/dl0KxR8f3KqN49yCTyAkg7kVLNvgHh72YViAd9Z81JMLcakAp+bkFM+RbCsMxLn1Wnism1Hjh/YsSp2ZMtqjIjq7LW+9SWnqrzODjCQijFGPxiC71Ynp/RJrZnjehzZ+Q9fNggLmTcf8AAAAABJRU5ErkJggg==)](https://www.griefed.de)
    [![Blog](https://img.shields.io/badge/Griefed.de-Blog-c0ffee?style=for-the-badge&labelColor=325358&logo=wordpress)](https://www.griefed.de/blog)
    [![Fleet](https://img.shields.io/badge/Griefed.de-Fleet-c0ffee?style=for-the-badge&labelColor=325358&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAABiVBMVEUAAAD///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8XJWL///8gNCTuAAAAgXRSTlMAAgMEBQYHCAkLDA4PEBESFhgZGh0eISIlKC8zNDU3OT0+P0BBQkhKS01QU1RVVltcXWJjZGlrbG1wcnN0eHl6e4CBhYyOkJWWmZ6foaKkqaqsrrKztLe8vsHExcbHy8zNz9DT1NXX2Nna293e3+Tm5+nq7O3u7/Hy9fb4+fr7/f4zgtRAAAABWklEQVR42mKgHhCFMbg0dHW1xNGlBcw5wTS7tkcJoNV5UJItBoMA3GPjcm3btm3btq1+8s1JxijuV0p+X5NzVcfNRoT4O26ClEZykdydI5ddCHDt+EfqthiwYoXfRH++yb9r8IZ+o/CpeB1hE/zMtXf0KYKkP9p8ZSaCfq1S2ddDU84zrsuXYXZjYy0VcBxQKYVmgQ9slS8HhUbxSP+kNAPB+kIyO1ggr5mn9GoX70wKydA4/RNQQSVPvGspZEHQ5ZKHK5lu8UymUi/enRQuxYjcN5LPH+RTQfcVlQ4AbfJ1n4JKRusG0ErpzCn3vjFMe8g9/eUU2himHEAilc+Vq6XJ4Zyx6eXTk3f6/IOww7i2oOliXNXQ/H5kHBcWSO2MowyKJc4VU/BLOGcMm04EJF3FyHsQImkvMj/tQBhrz0to+rwSUf70XvjT23VWxKLLaBkYGuqr+Y8f9Q3q0fzzGED8cgAAAABJRU5ErkJggg==)](https://fleet.griefed.de)
    [![GitHub](https://img.shields.io/badge/Griefed.de-Github-c0ffee?style=for-the-badge&labelColor=325358&logo=github)](https://github.com/Griefed)
    [![DockerHub](https://img.shields.io/badge/Griefed.de-DockerHub-c0ffee?style=for-the-badge&labelColor=325358&logo=docker&logoColor=white)](https://hub.docker.com/u/griefed)
    
    [![Discord](https://img.shields.io/badge/Griefed.de-Discord-c0ffee?style=for-the-badge&labelColor=325358&logo=discord&logoColor=white)](https://discord.griefed.de)
    
    Griefed's avatar
    Griefed committed
    
    ---
    
    
    # Sources, GitHub, GitLab and Mirroring and all that good stuff
    
    Repositories on GitHub are now for issues only. I've set up my own installation of GitLab and moved all my repositories over to [Git.Griefed.de](https://git.griefed.de/users/Griefed/projects). Make sure to check there first for the latest code before opening an issue on GitHub.
    
    For questions, you can always join my [Discord server](https://discord.griefed.de) and talk to me there.
    
    ---
    
    
    Griefed's avatar
    Griefed committed
    # TEMPLATE
    
    Griefed's avatar
    Griefed committed
    
    [![Docker Pulls](https://img.shields.io/docker/pulls/griefed/GRIEFED_DOCKERHUB_REPO?style=for-the-badge&logo=Docker&labelColor=325358&color=c0ffee&logoColor=white)](GRIEFED_DOCKERHUB_REPO)
    [![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/GRIEFED_DOCKERHUB_REPO?label=Image%20size&sort=date&style=for-the-badge&logo=Docker&labelColor=325358&color=c0ffee&logoColor=white)](GRIEFED_DOCKERHUB_REPO)
    [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/GRIEFED_DOCKERHUB_REPO?label=Docker%20build&style=for-the-badge&logo=Docker&labelColor=325358&color=c0ffee&logoColor=white)](GRIEFED_DOCKERHUB_REPO)
    [![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/GRIEFED_DOCKERHUB_REPO?label=Docker%20build&style=for-the-badge&logo=Docker&labelColor=325358&color=c0ffee&logoColor=white)](GRIEFED_DOCKERHUB_REPO)
    [![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/GRIEFED_GITHUB_REPO?label=GitHub%20Stars&style=for-the-badge&logo=Github&labelColor=325358&color=c0ffee)](GRIEFED_GITHUB_REPO)
    [![GitHub forks](https://img.shields.io/github/forks/Griefed/GRIEFED_GITHUB_REPO?label=GitHub%20Forks&style=for-the-badge&logo=Github&labelColor=325358&color=c0ffee)](GRIEFED_GITHUB_REPO)
    
    
    Griefed's avatar
    Griefed committed
    This is a description.
    
    Griefed's avatar
    Griefed committed
    
    
    Griefed's avatar
    Griefed committed
    [![TEMPLATE](GRIEFED_GITHUB_REPO_SCREENSHOT)](ORIGINAL_GITHUB_REPO)
    
    Griefed's avatar
    Griefed committed
    
    
    Griefed's avatar
    Griefed committed
    [[_TOC_]]
    
    
    Griefed's avatar
    Griefed committed
    ---
    
    Creates a Container which runs [CREATOR_NAME's](https://github.com/CREATOR_NAME) [CREATOR_REPO](CREATOR_REPO), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on EXAMPLE_WEBSITE_IF_EXISTS.
    
    The [lsiobase/alpine](https://hub.docker.com/r/lsiobase/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
    
    Tags | Description
    -----|------------
    `latest` | Using the `latest` tag will pull the latest image for linux/amd64,linux/arm/v7,linux/arm64.
    `develop` | The latest image of, if existent, the in-dev version of this container. Use at your own risk!
    
    Using GitHub Workflows, images for this container are multi-arch. Simply pulling `:latest` should retrieve the correct image for your architecture.
    Images are available for linux/amd64,linux/arm/v7,linux/arm64.
    
    ## pre-built images
    
    ```docker-compose.yml
    version: "2"
    services:
      GRIEFED_DOCKERHUB_REPO:
        container_name: GRIEFED_DOCKERHUB_REPO
        restart: on-failure:3
        image: GRIEFED_DOCKERHUB_REPO
        ports:
          - 8080:PORT
        environment:
          - TZ=Europe/Berlin
          - PUID=1000
          - PGID=1000
        volumes:
          - ./path/to/config:/config
          - ./path/to/data:/data  
    ```
    
    ## cli
    
    ```bash
    GET_FROM_FLEET
    ```
    
    # Configuration
    
    
    | Configuration                                                           | Explanation                                      |
    |-------------------------------------------------------------------------|--------------------------------------------------|
    | [Restart policy](https://docs.docker.com/compose/compose-file/#restart) | "no", always, on-failure, unless-stopped         |
    | TZ                                                                      | Timezone                                         |
    | PUID                                                                    | for UserID                                       |
    | PGID                                                                    | for GroupID                                      |
    | ports                                                                   | The port where the service will be available at. |
    
    Griefed's avatar
    Griefed committed
    
    ## User / Group Identifiers
    
    
    When using volumes, permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
    
    Griefed's avatar
    Griefed committed
    
    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)
    ```
    
    # Building the image yourself
    
    
    Griefed's avatar
    Griefed committed
    Use the [Dockerfile](GRIEFED_GITHUB_REPO/Dockerfile) to build the image yourself, in case you want to make any changes to it
    
    Griefed's avatar
    Griefed committed
    
    docker-compose.yml:
    
    ```docker-compose.yml
    version: "2"
    services:
      GRIEFED_DOCKERHUB_REPO:
        container_name: GRIEFED_DOCKERHUB_REPO
        restart: on-failure:3
        build: ./GRIEFED_GITHUB_REPO
        ports:
          - 8080:PORT
        environment:
          - TZ=Europe/Berlin
          - PUID=1000
          - PGID=1000
        volumes:
          - ./path/to/config:/config
          - ./path/to/data:/data  
    ```
    
    1. Clone the repository: `git clone GRIEFED_GITHUB_REPO.git ./GRIEFED_GITHUB_REPO`
    1. Prepare docker-compose.yml file as seen above
    1. `docker-compose up -d --build GRIEFED_DOCKERHUB_REPO`
    1. Visit IP.ADDRESS.OF.HOST:8080
    1. ???
    
    Griefed's avatar
    Griefed committed
    1. Profit!