Compare commits
No commits in common. "beb9014b9447c5f410870c893b41b8c794f9376b" and "ac5f9447709b7d144e2c3b5b95a6ce8efc4c9a1e" have entirely different histories.
beb9014b94
...
ac5f944770
27
README.md
27
README.md
|
|
@ -1,5 +1,24 @@
|
||||||
# self-hosting
|
<!---
|
||||||
|
|
||||||
|
Copyright (C) 2020 Jef Roosens
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
# self-hosting
|
||||||
# Contents
|
# Contents
|
||||||
The repo contains setup guides for the following:
|
The repo contains setup guides for the following:
|
||||||
|
|
||||||
|
|
@ -16,11 +35,9 @@ Each directory contains (or will contain) its own `README.md` to aid with the
|
||||||
installation of that specific setup.
|
installation of that specific setup.
|
||||||
|
|
||||||
# General info
|
# General info
|
||||||
|
|
||||||
This info applies to all configs.
|
This info applies to all configs.
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
All the setups named above use Docker and docker-compose. If you're on a
|
All the setups named above use Docker and docker-compose. If you're on a
|
||||||
Linux-based server, you can find both `docker` and `docker-compose` in your
|
Linux-based server, you can find both `docker` and `docker-compose` in your
|
||||||
package manager (do note that the Docker package might be called `docker.io`).
|
package manager (do note that the Docker package might be called `docker.io`).
|
||||||
|
|
@ -28,27 +45,23 @@ Otherwise, the install instructions can be found
|
||||||
[here](https://docs.docker.com/engine/install/).
|
[here](https://docs.docker.com/engine/install/).
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Most configuration can be done using a `.env` file with a provided
|
Most configuration can be done using a `.env` file with a provided
|
||||||
`.env.example` file to start from. This means that you never have to edit the
|
`.env.example` file to start from. This means that you never have to edit the
|
||||||
compose files, unless you wish to deviate from the default format.
|
compose files, unless you wish to deviate from the default format.
|
||||||
|
|
||||||
## Building the image
|
## Building the image
|
||||||
|
|
||||||
You can build the container image using the command `docker-compose build`.
|
You can build the container image using the command `docker-compose build`.
|
||||||
This will build all services specified in the `docker-compose.yml` file. Any
|
This will build all services specified in the `docker-compose.yml` file. Any
|
||||||
build configuration/environment variables can be defined in a `.env` file. A
|
build configuration/environment variables can be defined in a `.env` file. A
|
||||||
`.env.example` file is given for each configuration.
|
`.env.example` file is given for each configuration.
|
||||||
|
|
||||||
## Running the container
|
## Running the container
|
||||||
|
|
||||||
For running the server, we can use `docker-compose up -d`. This will start the
|
For running the server, we can use `docker-compose up -d`. This will start the
|
||||||
service in the background. You can then see any logs using
|
service in the background. You can then see any logs using
|
||||||
`docker-compose logs`. If you want the logs to update automatically, use
|
`docker-compose logs`. If you want the logs to update automatically, use
|
||||||
`docker-compose logs -f`.
|
`docker-compose logs -f`.
|
||||||
|
|
||||||
# Why did I make this?
|
# Why did I make this?
|
||||||
|
|
||||||
Well, I just wanted to put all my knowledge in one basket. this makes it easier
|
Well, I just wanted to put all my knowledge in one basket. this makes it easier
|
||||||
to manage and share with others. I spend a lot of time tweaking these configs
|
to manage and share with others. I spend a lot of time tweaking these configs
|
||||||
and figuring out how they work best (for me at least), and wanted to share this
|
and figuring out how they work best (for me at least), and wanted to share this
|
||||||
|
|
|
||||||
|
|
@ -24,7 +24,6 @@ services:
|
||||||
- './.env:/var/www/html/.env'
|
- './.env:/var/www/html/.env'
|
||||||
- 'covers:/var/www/html/public/img/covers'
|
- 'covers:/var/www/html/public/img/covers'
|
||||||
- 'music:/music'
|
- 'music:/music'
|
||||||
- 'index:/var/www/html/storage/search-indexes'
|
|
||||||
|
|
||||||
db:
|
db:
|
||||||
image: 'mariadb:10.5.9-focal'
|
image: 'mariadb:10.5.9-focal'
|
||||||
|
|
@ -46,5 +45,4 @@ networks:
|
||||||
volumes:
|
volumes:
|
||||||
covers:
|
covers:
|
||||||
db-data:
|
db-data:
|
||||||
index:
|
|
||||||
music:
|
music:
|
||||||
|
|
|
||||||
|
|
@ -57,9 +57,3 @@ PORTAINER_HOST=portainer_app_1
|
||||||
GITEA_DOMAIN=
|
GITEA_DOMAIN=
|
||||||
### Hostname
|
### Hostname
|
||||||
GITEA_HOST=gitea_app_1
|
GITEA_HOST=gitea_app_1
|
||||||
|
|
||||||
## Podgrab
|
|
||||||
### Domain name
|
|
||||||
PODGRAB_DOMAIN=
|
|
||||||
### Hostname
|
|
||||||
PODGRAB_HOST=podgrab_app_1
|
|
||||||
|
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
server {
|
|
||||||
# SSL Key locations
|
|
||||||
ssl_certificate /etc/letsencrypt/live/${PODGRAB_DOMAIN}/fullchain.pem;
|
|
||||||
ssl_certificate_key /etc/letsencrypt/live/${PODGRAB_DOMAIN}/privkey.pem;
|
|
||||||
listen ${HTTPS_PORT} ssl;
|
|
||||||
listen [::]:${HTTPS_PORT} ssl;
|
|
||||||
|
|
||||||
server_name ${PODGRAB_DOMAIN};
|
|
||||||
|
|
||||||
location / {
|
|
||||||
resolver 127.0.0.11;
|
|
||||||
proxy_pass http://${PODGRAB_HOST}:8080/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Reference in New Issue