Edit Formatting To Be more consistent

pull/4/head
Tai 3 years ago
parent fc00cfede2
commit 41b07f190c

@ -2,7 +2,7 @@ Heimdall Application Dashboard
Official Site: https://heimdall.site/ Official Site: https://heimdall.site/
## Minimum File Structure ### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/

@ -1,7 +1,7 @@
## Intro ### Intro
This guide references: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker as the original source for installation. This guide references: https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker as the original source for installation.
## Minimum File Structure ### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/
@ -272,7 +272,7 @@ networks:
name: caddy_net name: caddy_net
``` ```
.env ### .env
Here you want to edit the PUBLIC_URL to match your subdomain.example.com Here you want to edit the PUBLIC_URL to match your subdomain.example.com
Then after saving this. Run the script called ./gen-passwords.sh to generate the 6 passwords. Then after saving this. Run the script called ./gen-passwords.sh to generate the 6 passwords.

@ -1,3 +1,4 @@
### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/

@ -20,7 +20,7 @@ WIND_PASS=
WIND_PORT= WIND_PORT=
``` ```
#### docker-compose.yml ### docker-compose.yml
``` ```
version: "2.1" version: "2.1"
services: services:

@ -1,4 +1,4 @@
# Minimum File Structure ### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/
@ -8,7 +8,7 @@
├── docker-compose.yml ├── docker-compose.yml
``` ```
## Add to Caddyfile (from ~/docker/caddy) ### Add to Caddyfile (from ~/docker/caddy)
Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile. Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile.
``` ```
subdomain.example.com { subdomain.example.com {
@ -16,9 +16,7 @@ subdomain.example.com {
} }
``` ```
# Things to Modify ### .env
## .env
set your environment variables set your environment variables
``` ```
# General # General
@ -32,7 +30,7 @@ SEAFILE_ADMIN_PASSWORD=examplepass # Specifies Seafile admin password.
SEAFILE_HOSTNAME=subdomain.example.com SEAFILE_HOSTNAME=subdomain.example.com
``` ```
## docker-compose.yml ### docker-compose.yml
``` ```
version: '2.0' version: '2.0'
services: services:
@ -85,10 +83,10 @@ You may need to add the following lines to your docker file if you plan on enabl
``` ```
After that you do this open this port on your firewall and redirect it to the Docker Host's IP with seafile running on it. After that you do this open this port on your firewall and redirect it to the Docker Host's IP with seafile running on it.
## docker-compose up -d ### docker-compose up -d
After you have the .env and docker-compose files set up in this directory. Do a ```docker-compose up -d``` to start the containers. After they start modify seahub_settings.py and ccnet.conf as shown below. After you have the .env and docker-compose files set up in this directory. Do a ```docker-compose up -d``` to start the containers. After they start modify seahub_settings.py and ccnet.conf as shown below.
## seahub_settings.py ### seahub_settings.py
nano /home/~/docker/seafile/seafile-data/seafile/conf/seahub_settings.py nano /home/~/docker/seafile/seafile-data/seafile/conf/seahub_settings.py
Change FILE_SERVER_ROOT to be https instead of http. Change FILE_SERVER_ROOT to be https instead of http.
@ -97,7 +95,7 @@ Example Below:
FILE_SERVER_ROOT = "https://subdomain.example.com/seafhttp" FILE_SERVER_ROOT = "https://subdomain.example.com/seafhttp"
``` ```
## ccnet.conf ### ccnet.conf
nano /home/~/docker/seafile/seafile-data/seafile/conf/ccnet.conf nano /home/~/docker/seafile/seafile-data/seafile/conf/ccnet.conf
Change SERVICE_URL from http to https and remove the :8000 at the end. Change SERVICE_URL from http to https and remove the :8000 at the end.
@ -108,7 +106,7 @@ SERVICE_URL https://subdomain.example.com
# Optional: Setting Up WebDav # Optional: Setting Up WebDav
## Caddyfile ### Caddyfile
``` ```
webdav.example.com { webdav.example.com {
reverse_proxy seafile:80 reverse_proxy seafile:80
@ -116,7 +114,7 @@ webdav.example.com {
``` ```
Here I assigned a new subdomain webdav and point it to port 8080 which is the defualt on seafdav.conf Here I assigned a new subdomain webdav and point it to port 8080 which is the defualt on seafdav.conf
## seafdav.conf ### seafdav.conf
``` ```
nano /home/~/docker/seafile/seafile-data/seafile/conf/seafdav.conf nano /home/~/docker/seafile/seafile-data/seafile/conf/seafdav.conf
``` ```

@ -93,7 +93,7 @@ docker-compose up -d
# rm docker-compose.yml # rm docker-compose.yml
``` ```
# Minimum File Structure ### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/
@ -102,7 +102,7 @@ docker-compose up -d
├── docker-compose.yml ├── docker-compose.yml
``` ```
## Add to Caddyfile (from ~/docker/caddy) ### Add to Caddyfile (from ~/docker/caddy)
Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile. Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile.
``` ```
shinobi.yourdomain.com { shinobi.yourdomain.com {
@ -110,7 +110,7 @@ shinobi.yourdomain.com {
} }
``` ```
# docker-compose.yml ### docker-compose.yml
Notes: No tensorflow option. Use script above if you want that feature. Notes: No tensorflow option. Use script above if you want that feature.
``` ```
@ -137,10 +137,10 @@ networks:
name: caddy_net name: caddy_net
``` ```
# Why port 521 Open? ## Why port 521 Open?
Why did I do ports 521:521? Well I wanted to enable FTP inside the docker with port 521 open (see below). You don't have to choose 521 this is arbitrary make sure your conf.json matches.. I will assume no port forward is needed on the router because Cameras and Shinobi NVR is on the sane LAN. Why did I do ports 521:521? Well I wanted to enable FTP inside the docker with port 521 open (see below). You don't have to choose 521 this is arbitrary make sure your conf.json matches.. I will assume no port forward is needed on the router because Cameras and Shinobi NVR is on the sane LAN.
# shinobi/config/conf.json ## shinobi/config/conf.json
Here I added the following lines to conf.json to enable FTP. Here I added the following lines to conf.json to enable FTP.
``` ```
@ -151,10 +151,10 @@ Here I added the following lines to conf.json to enable FTP.
"thisIsDocker": true, "thisIsDocker": true,
``` ```
# Camera specific notes ## Camera specific notes
You may need to port forward RTSP or RTMP ports for your cameras. You may need to port forward RTSP or RTMP ports for your cameras.
# Reolink Specific (RLC-410-5MP and RLC-520) Gotchas ## Reolink Specific (RLC-410-5MP and RLC-520) Gotchas
### RTMP Main Stream (High Bit Rate 1024Kbps ~ 8192Kbps) ### RTMP Main Stream (High Bit Rate 1024Kbps ~ 8192Kbps)
rtmp://[USERNAME]:[PASSWORD]@CAMERAIPADDRESS:PORT/bcs/channel0_main.bcs?token=sdasdasc&channel=0&stream=0&user=[USERNAME]&password=[PASSWORD] rtmp://[USERNAME]:[PASSWORD]@CAMERAIPADDRESS:PORT/bcs/channel0_main.bcs?token=sdasdasc&channel=0&stream=0&user=[USERNAME]&password=[PASSWORD]

@ -1,4 +1,4 @@
#### Tips ### Tips
Don't even use caddy for this deployment I don't know how to make it work. Don't even use caddy for this deployment I don't know how to make it work.
Just use the forwarded ports. Make sure UFW allows all the required ports such as 3478, 10001, 8080, etc... Just use the forwarded ports. Make sure UFW allows all the required ports such as 3478, 10001, 8080, etc...
@ -14,7 +14,7 @@ After `docker-compose up -d`. Navigate to HOSTIPADDRESS:8080 to access the contr
├── docker-compose.yml ├── docker-compose.yml
``` ```
#### docker-compose.yml ### docker-compose.yml
``` ```
--- ---
version: "2.1" version: "2.1"

@ -1,4 +1,4 @@
# Minimum File Structure ### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/

@ -1,4 +1,4 @@
# Minimum File Structure ### Minimum File Structure
``` ```
/home/ /home/
└── ~/ └── ~/
@ -8,7 +8,7 @@
├── docker-compose.yml ├── docker-compose.yml
``` ```
## Add to Caddyfile (from ~/docker/caddy) ### Add to Caddyfile (from ~/docker/caddy)
Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile. Remember to `docker exec -w /etc/caddy caddy caddy reload` after editing your Caddyfile.
``` ```
zoneminder.yourdomain.com { zoneminder.yourdomain.com {
@ -16,7 +16,7 @@ zoneminder.yourdomain.com {
} }
``` ```
## docker-compose.yml ### docker-compose.yml
Notes on some compose settings. Notes on some compose settings.
Why is priviledged set to true? So the docker container can access system resources like a CUDA GPU for object detection. Why is priviledged set to true? So the docker container can access system resources like a CUDA GPU for object detection.
Timezone should be adjusted to your time zone. Timezone should be adjusted to your time zone.
@ -55,5 +55,5 @@ networks:
name: caddy_net name: caddy_net
``` ```
## other notes ### other notes
Certificates are located in /config/keys/ Certificates are located in /config/keys/

Loading…
Cancel
Save