Skip to content

Commit e84d67e

Browse files
committed
Update README
1 parent 2d23315 commit e84d67e

File tree

1 file changed

+3
-51
lines changed

1 file changed

+3
-51
lines changed

README.md

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,8 @@
11
# OS2BorgerPC Hosting and Deployment
22

3-
This is a deployment tool designed for hosting the OS2BorgerPC Admin Site application using Docker. It provides a Docker-based setup and pre-configured files to simplify the deployment and management of the application.
3+
This is a deployment setup designed for hosting the OS2BorgerPC Admin Site application using Docker.
44

5-
## Pre-installation Requirements
5+
A Taskfile provides automation for common tasks like install, upgrade, stop and start.
66

7-
### Secure Mode Configuration
7+
To learn more read the documentation at https://os2borgerpc.github.io/os2borgerpc-docs/
88

9-
It is assumed that the server will run in secure mode using HTTPS (port 443). To ensure proper operation, you must have a valid domain name and an SSL certificate.
10-
11-
**Steps to Enable Secure Mode:**
12-
13-
- **Domain Name:** Use a fully qualified domain name (FQDN) that points to your server’s IP address. Update `nginx.conf` with your domain name in two locations.
14-
- **SSL Certificate:** Obtain a valid SSL certificate and the corresponding private key for your domain.
15-
- Place the certificate file (`nginx.crt`) and the private key file (`nginx.key`) inside the `ssl` directory.
16-
17-
### Network Requirements
18-
19-
The OS2BorgerPC Admin server can operate reliably within a protected internal network, provided that outgoing HTTP and HTTPS traffic is permitted.
20-
This setup helps improve security while keeping the configuration simple.
21-
22-
Even in this setup, it's recommended to configure the server to run in secure mode using HTTPS.
23-
24-
### Make Your Server Available in the Connect Script
25-
26-
When connecting a newly installed BorgerPC to your OS2BorgerPC Admin server, the connect script displays a list of available servers to choose from.
27-
To include your server in this list, send an email to the coordination team at [[email protected]](mailto:[email protected]) with your server's domain name (FQDN).
28-
29-
Once received, we’ll update the list immediately, and the changes will take effect right away.
30-
31-
32-
33-
## Docker Compose Setup
34-
35-
The deployment uses Docker Compose to manage the services. Here is an overview of the services defined in the `docker-compose.yml` file:
36-
37-
### Services
38-
39-
- **os2borgerpc-admin**: This is the main service running the OS2BorgerPC Admin Site. It uses the image `ghcr.io/os2borgerpc/os2borgerpc-admin-site:7.0.1`. The service is configured to use environment variables from the `.env` file and mounts the `settings.py` file as read-only. It exposes ports `9999` and `8080`.
40-
41-
- **db**: This service runs a PostgreSQL database using the `postgres:latest` image. It is configured to always restart and uses environment variables from the `.env` file. The database data is persisted using the `postgres-data` volume.
42-
43-
- **nginx**: This service runs an Nginx proxy using the `nginx:latest` image. It is configured to handle SSL termination and proxy requests to the `os2borgerpc-admin` service. The Nginx configuration file (`nginx.conf`) and SSL certificates (`ssl` directory) are mounted as read-only. The service exposes ports `80` and `443`.
44-
45-
### Volumes
46-
47-
- **admin-media**: This volume is used to store media files for the `os2borgerpc-admin` service.
48-
- **postgres-data**: This volume is used to persist PostgreSQL database data.
49-
50-
### Proxy and SSL Certificates
51-
52-
The Nginx service acts as a reverse proxy for the `os2borgerpc-admin` service. It handles SSL termination and forwards requests to the appropriate backend service. The SSL certificates are stored in the `ssl` directory and are mounted into the Nginx container.
53-
54-
## Security Considerations
55-
56-
Security considerations for exposing this installation to the internet have not been made. If you plan to expose this setup to the internet, please ensure that you take appropriate security measures to protect the server and the application.

0 commit comments

Comments
 (0)