github/oneuptime
1
1
Fork 0
mirror of https://github.com/OneUptime/oneuptime.git synced 2026-04-06 00:32:12 +02:00
Code Issues 193 Packages Projects Releases Wiki Activity

refactor: Update TLS/SSL certificate setup instructions

Browse Source 
This commit updates the installation documentation and example configuration file to provide clear instructions on setting up TLS/SSL certificates for OneUptime. It emphasizes that OneUptime does not support setting up SSL/TLS certificates and provides steps for using a reverse proxy like Nginx or Caddy, along with Let's Encrypt, to provision the certificates. It also includes instructions for updating the necessary settings in the configuration file. This improvement ensures that users have the necessary information to secure their OneUptime installation with SSL/TLS certificates.
This commit is contained in:
Simon Larsen
2024-06-21 17:38:30 +01:00
parent 3d7cb148d0
commit 28ea4d9b83
2 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
App/FeatureSet/Docs/Content/installation/docker-compose.md
View File

@@ -65,6 +65,21 @@ npm run update
```
### Setting up TLS/SSL Certificates
OneUptime **does not** support setting up SSL/TLS certificates. You need to set up SSL/TLS certificates on your own.
If you need to use SSL/TLS certificates, follow these steps:
1. Use a reverse proxy like Nginx or Caddy.
2. Use Let's Encrypt to provision the certificates.
3. Point the reverse proxy to the OneUptime server.
4. Update the following settings:
- Set `HTTP_PROTOCOL` env var to `https`.
- Change `HOST` env var to the domain name of the server where the reverse proxy is hosted.
### Things to consider
- In our Docker setup, we employ a local logging driver. OneUptime, particularly within the probe and ingestor containers, generates a substantial amount of logs. To prevent your storage from becoming full, it's crucial to limit the logging storage in Docker. For detailed instructions on how to do this, please refer to the official Docker documentation [here](https://docs.docker.com/config/containers/logging/local/).

11
config.example.env
View File

@@ -3,7 +3,16 @@
# Please change this to domain of the server where oneuptime is hosted on.
HOST=localhost
# If this server is hosted on SSL / TLS then change this to https
# ==============================================
# SETTING UP TLS/SSL CERTIFICATES
# ==============================================
# OneUptime DOES NOT support setting up SSL/TLS certificates. You need to setup SSL/TLS certificates on your own.
# If you need to use SSL/TLS certificates, then you need to use a reverse proxy like Nginx/Caddy and use LetsEncrypt to provision the certificates.
# You then need to point the reverse proxy to the OneUptime server.
# Once you have done that,
# - You can set the HTTP_PROTOCOL to https
# - Change the HOST to the domain name of the server where reverse proxy is hosted.
HTTP_PROTOCOL=http
# Secrets - PLEASE CHANGE THESE. Please change these to something random. All of these can be different values.