This page consists of templates for docs, links etc⚓︎

Description⚓︎

Give a basic description of the app here

Bare Metal⚓︎

Basic info⚓︎

Getting started⚓︎

• Install PackageName package

  ArchDebian/Ubuntu

  Bash
  1	sudo pacman -Sy packageName

  Official Syncthing Guide

• Write further steps

Docker⚓︎

Basic info⚓︎

docker-compose.yml⚓︎

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

---
version: "3"
services:
  serviceName:
    image: MAINTAINER/IMAGE:latest #(1)
    container_name: myContainer #(2)
    restart: unless-stopped
    volumes:
      - "${CFG_DIR}/containerCfgDir:/config" #(3)
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    ports:
      - 80:80 #(4)
    networks:
      - proxy #(5)
    labels:
      traefik.enable: true
      traefik.http.services.portainer.loadbalancer.server.port: portNumber #(6)

networks:
  proxy: #(7)
    external: true

1. No tag defaults to latest
   Best practice is to test your stuff with new image and pin the container to that version
2. Name the container or docker would name it randomly
   Name used by traefik to autogenerate route
   i.e, traefik.example.com
3. Refer to variables guide
4. Change port number on left side
5. Same custom docker network as traefik
6. Specific port for traefik to route traffic from for this container
7. Specify your custom networks location here

deploy.sh⚓︎

1
2
3
4

#!/bin/sh
mkdir -p ${CFG_DIR}/containerCfgDir #(1)
mkdir -p ${CFG_DIR}/containerCfgDir/{multiple,subdirs} #(2)
docker compose up -d

1. Refer to variables guide
2. Use braces for variables and subdirectory names. No quotes

Template for link⚓︎

• ExampleLink

1

- [DisplayName](linkPath "HoverText"){:target="_blank" rel="noopener noreferrer"}