This commit is contained in:
PAPAMICA
2022-05-17 10:43:21 +02:00
parent f6cf6e8a58
commit 931c5092be
2 changed files with 3 additions and 272 deletions

View File

@@ -4,7 +4,7 @@ on:
branches: [ master ]
workflow_dispatch:
jobs:
test:
check-yaml:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
@@ -16,7 +16,8 @@ jobs:
run: pip install yamllint
- name: Lint YAML files
run: yamllint --format github -d .github/workflows/conf_yaml ./composes-files/*
build:
generate-files:
needs: check-yaml
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

270
README.md
View File

@@ -1,270 +0,0 @@
<p align="center">
<a href="https://papamica.com">
<img src="https://zupimages.net/up/20/04/7vtd.png" width="140px" alt="PAPAMICA" />
</a>
</p>
<p align="center">
<a href="#"><img src="https://readme-typing-svg.herokuapp.com?center=true&vCenter=true&lines=Docker+compose+collection;"></a>
</p>
<p align="center">
<a href="https://github.com/PAPAMICA/docker-compose-collection#list-of-services-availables"><img src="https://img.shields.io/badge/List_of_services-%2341454A.svg?style=for-the-badge&logo=target&logoColor=white"> </a>
<a href="https://github.com/PAPAMICA/docker-compose-collection#utilisation"><img src="https://img.shields.io/badge/How_to_use-%2341454A.svg?style=for-the-badge&logo=target&logoColor=white"> </a>
<a href="https://github.com/PAPAMICA/docker-compose-collection#add-new-docker-compose-file"><img src="https://img.shields.io/badge/Add_new_service-%2341454A.svg?style=for-the-badge&logo=target&logoColor=white"> </a>
<br />
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/PAPAMICA/docker-compose-collection/CI?label=Files%20generating&logo=files&logoColor=white&style=for-the-badge">
<br />
<a href="https://www.docker.com/"><img src="https://img.shields.io/badge/docker-%232496ED.svg?style=for-the-badge&logo=docker&logoColor=white"> </a>
<a href="https://www.portainer.io/"><img src="https://img.shields.io/badge/portainer-%2313BEF9.svg?style=for-the-badge&logo=portainer&logoColor=white"> </a>
<a href="https://traefik.io/traefik/"><img src="https://img.shields.io/badge/traefik_proxy-%231F93B1.svg?style=for-the-badge&logo=traefikmesh&logoColor=white"> </a>
<br />
</p>
<div align="center">
These docker-compose allow you to deploy multiple services easily and quickly.
You can use them with Portainer directly or via docker-compose commands.
All docker-compose are commented and are configured using variables.
They all include support for Traefik.
You can deploye a compatible Docker environment with Portainer and Traefik with:
<p align="center">
<a href="https://github.com/PAPAMICA/docker-environment"><img src="https://img.shields.io/badge/docker_environment-%2300B8FC.svg?style=for-the-badge&logo=github&logoColor=white"></a>
</p>
## List of services availables:
<img src="https://img.shields.io/badge/Avaibles:_33-%2354B848.svg?style=for-the-badge&logo=cachet&logoColor=white">
| Status | Service | Update | Maintainer |
|:--:|--|--|--|
| ✅ | adminer | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | apprise-api | 2022-05-13 | Mickael "PAPAMICA" Asseline |
| ✅ | bookstack | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | dillinger | 2022-05-13 | Mickael "PAPAMICA" Asseline |
| ✅ | etherpad | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | ferdi | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | filebot | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | filebrowser | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | grafana | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | hastebin | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | jirafeau | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | keycloak | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | matomo | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | mumble-bot | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | mumble-web | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | murmur | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | nextcloud | 2022-05-11 | Mickael "PAPAMICA" Asseline |
| ✅ | olivetin | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | plex | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | rundeck | 2022-05-17 | Mickael "PAPAMICA" Asseline |
| ✅ | sinusbot | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | teamspeak | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | traefik | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | ts3rank | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | ts3viewer | 2022-05-12 | Mickael "PAPAMICA" Asseline |
| ✅ | umami | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | vaultwarden | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | vscode | 2022-05-11 | Mickael "PAPAMICA" Asseline |
| ✅ | website-html | 2022-05-10 | Mickael "PAPAMICA" Asseline |
| ✅ | wordpress | 2022-05-11 | Mickael "PAPAMICA" Asseline |
| ✅ | yourls | 2022-05-13 | Mickael "PAPAMICA" Asseline |
| ✅ | zabbix-proxy | 2022-05-17 | Mickael "PAPAMICA" Asseline |
| ✅ | zabbix | 2022-05-11 | Mickael "PAPAMICA" Asseline |
## List of services to do:
<img src="https://img.shields.io/badge/To_do:_98-%23FF8800.svg?style=for-the-badge&logo=vlcmediaplayer&logoColor=white">
| Status | Service |
|:--:|--|
| 🚸 | adguard |
| 🚸 | airsonic |
| 🚸 | audacity |
| 🚸 | authelia |
| 🚸 | bazarr |
| 🚸 | cachethq |
| 🚸 | calibre-web |
| 🚸 | chevereto |
| 🚸 | dashmachine |
| 🚸 | deemix |
| 🚸 | deluge |
| 🚸 | domotics |
| 🚸 | duplicaty |
| 🚸 | elasticsearch |
| 🚸 | emby |
| 🚸 | embystat |
| 🚸 | emulatorjs |
| 🚸 | freshrss |
| 🚸 | gitlab |
| 🚸 | grav |
| 🚸 | guacamole |
| 🚸 | heimdall |
| 🚸 | homeassistant |
| 🚸 | homer |
| 🚸 | httpd |
| 🚸 | jacket |
| 🚸 | jellyfin |
| 🚸 | jenkins |
| 🚸 | joomla |
| 🚸 | joplin |
| 🚸 | lidarr |
| 🚸 | lychee |
| 🚸 | magento |
| 🚸 | mariadb |
| 🚸 | mautic |
| 🚸 | mcmyadmin2 |
| 🚸 | minetest |
| 🚸 | minio |
| 🚸 | n8m |
| 🚸 | nginx-proxy-manager |
| 🚸 | nginx |
| 🚸 | nzbget |
| 🚸 | ombi |
| 🚸 | openvpn-as |
| 🚸 | openvpn |
| 🚸 | organizr |
| 🚸 | outline |
| 🚸 | owncoud |
| 🚸 | paperless-ng |
| 🚸 | papermerge |
| 🚸 | petio |
| 🚸 | phpmyadmin |
| 🚸 | pi-hole |
| 🚸 | piwigo |
| 🚸 | pixapop |
| 🚸 | plone |
| 🚸 | postgresql |
| 🚸 | privatebin |
| 🚸 | projectsend |
| 🚸 | prowlarr |
| 🚸 | radarr |
| 🚸 | raneto |
| 🚸 | rdesktop |
| 🚸 | reactive-resume |
| 🚸 | read-the-docs |
| 🚸 | redis |
| 🚸 | redmine |
| 🚸 | registry |
| 🚸 | requestrr |
| 🚸 | rutorrent |
| 🚸 | scality-s3 |
| 🚸 | scrutiny |
| 🚸 | shiori |
| 🚸 | shlink |
| 🚸 | shorturl |
| 🚸 | snapdrop |
| 🚸 | snibox |
| 🚸 | snipe-it |
| 🚸 | sonarr |
| 🚸 | taiga |
| 🚸 | tautulli |
| 🚸 | thelounge |
| 🚸 | tiddlywiki |
| 🚸 | tiny-tiny-rss |
| 🚸 | transmission |
| 🚸 | turtl |
| 🚸 | unify-controller |
| 🚸 | urbackup |
| 🚸 | vault |
| 🚸 | webtop |
| 🚸 | whoogle |
| 🚸 | wikijs |
| 🚸 | wireguard |
| 🚸 | wiznote |
| 🚸 | wowza |
| 🚸 | yatch |
| 🚸 | youtube-dl |
| 🚸 | zabbix-cachethq |
</div>
---
# Utilisation
## Portainer
Add the URL of my repo directly in Portainer:
![PORTAINER](https://i.imgur.com/M49ssCN.png)
## Debian
Install Git :
```bash
apt install -y git
```
Clone repo
```bash
git clone https://github.com/PAPAMICA/docker-compose-collection/
```
Configuration of variables and execution of a docker-compose:
```bash
cd docker-compose-collection
nano env
sudo docker-compose -f service.yml --env-file env up -d
```
## Some useful commands:
- **docker container ls** : Show current Docker containers
- **docker-compose stop** : Stop the containers created with the scripts (in the script folder)
- **docker-compose up -d** : Launch the containers created with the scripts (in the script folder)
- **docker logs -f <id_container>** : Display the container logs
- **docker exec -it <id_container> bash** : Get a shell in container
---
# Add new docker-compose file
I automated the creation of the json template file for Portainer and the update of the README.md.
If you want to add a new docker-compose, you must use the following template:
```yaml
# Docker-compose provided by Mickael "PAPAMICA" Asseline
# Update: 2022-10-05
#& type: 3
#& title: Hastebin
#& description: Share your code easily
#& note: Website: <a href='https://hastebin.com/about.md' target='_blank' rel='noopener'>Hastebin.com</a>
#& categories: SelfHosted, PAPAMICA
#& platform: linux
#& logo: https://progsoft.net/images/hastebin-icon-b45e3f5695d3f577b2630648bd00584195822e3d.png
#% SERVICE: Name of the service (No spaces or points)
#% DATA_LOCATION: Data localization (Example: /apps/service)
#% URL: Service URL (Example: service.papamica.fr or service.com)
#% NETWORK: Your Traefik network (Example: proxy)
# Work with Portainer
version: "2"
services:
# Hastebin : https://hastebin.com/about.md
hastebin:
image: rlister/hastebin:latest
container_name: $SERVICE
restart: always
environment:
STORAGE_TYPE: file
volumes:
- $DATA_LOCATION/data:/data
healthcheck:
test: wget -s 'http://localhost:7777'
interval: 1m
timeout: 30s
retries: 3
networks:
- default
labels:
- "autoupdate=monitor" # https://github.com/PAPAMICA/container-updater
- "traefik.enable=true"
- "traefik.http.routers.$SERVICE.entrypoints=https"
- "traefik.http.routers.$SERVICE.rule=Host(`$URL`)"
- "traefik.http.routers.$SERVICE.tls=true"
- "traefik.http.routers.$SERVICE.tls.certresolver=http"
- "traefik.docker.network=$NETWORK"
networks:
default:
external:
name: $NETWORK
```