From fbf83f5fd79d89490fa59096335ba4f4d89ed38b Mon Sep 17 00:00:00 2001 From: Basil Bruhn Date: Fri, 8 Nov 2024 09:36:35 +0100 Subject: [PATCH] review --- services/admin-guide/webhosting.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/services/admin-guide/webhosting.md b/services/admin-guide/webhosting.md index 9a1f43d3..f6d64f88 100644 --- a/services/admin-guide/webhosting.md +++ b/services/admin-guide/webhosting.md @@ -1,18 +1,25 @@ # WebHosting -WebHosting is a service for running simple web apps without the need to operate and maintain a virtual machine. Based on Docker, it allows users to configure their applications and access them through an NGINX reverse proxy, which directs requests to the appropriate service. Each service has a configuration file inside `conf.d`. Currently, certificates are deployed by the Linux engineering team until an automated ACME solution becomes available. The content for hosted websites will be available on an NFS share, which you can access. +WebHosting is a service for running simple web apps without the need to operate and maintain a virtual machine. Based on Docker compose, it allows users to configure their applications and access them through an NGINX reverse proxy, which directs requests to the appropriate service. Certificates will be deployed by us. The content for hosted websites will be available on an NFS share, which you can access. + +## Available Services + +- Elog is pre-configured as a container and can be ordered or configured by you. + ## How to Use the Service +> **Note:** If you need assistance at any step, reach out to [linux-eng](mailto:linux-eng@psi.ch). + 1. **Prepare Your Service** - - Ensure your service is running in a Docker container. + - Ensure your service is running in one or more Docker container. 2. **Create a Branch or Fork** - Navigate to the repository: [WebHosting](https://git.psi.ch/linux-infra/WebHosting) 3. **Edit the Docker Configuration** - - Update the `docker-compose.yaml` file located in the repository with the necessary configuration for your web server. - - Add your web server configuration file to the `conf.d` directory (use `proxy_pass` with the container's name as specified in `docker-compose.yaml`). + - Update the `docker-compose.yaml` file in the repository to include you service container(s). + - Add a configuration file for your service to the `conf.d` directory, specifying `proxy_pass` with the container's name as defined in `docker-compose.yaml` to route requests properly through the nginx reverse proxy to your container(s). 4. **Create a Merge Request** - Submit a merge request in the [WebHosting](https://git.psi.ch/linux-infra/WebHosting) repository. @@ -24,15 +31,11 @@ WebHosting is a service for running simple web apps without the need to operate 6. **Deployment** - The service is automatically deployed upon merging to the main branch. -> **Note:** If you need assistance at any step, reach out to [linux-eng](mailto:linux-eng@psi.ch). ## Additional Information -- **Available Services** - - Elog is pre-configured as a container and can be ordered or configured by you. - - **Backup Schedule** - - Logbooks are backed up hourly, retained for one week. + - Elog Logbooks are backed up hourly, retained for one week. - Other web content is backed up four times daily. - **Running Multiple Containers**