From cb4c950a169fbf047c80f47b9a30ae40e1ef6663 Mon Sep 17 00:00:00 2001 From: Basil Bruhn Date: Wed, 6 Nov 2024 16:35:11 +0100 Subject: [PATCH] webhosting docu --- services/admin-guide/webosting.md | 40 +++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 services/admin-guide/webosting.md diff --git a/services/admin-guide/webosting.md b/services/admin-guide/webosting.md new file mode 100644 index 00000000..470d5103 --- /dev/null +++ b/services/admin-guide/webosting.md @@ -0,0 +1,40 @@ +# WebHosting Guide + +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. + +## How to Use the Service + +1. **Access the Repository** + - Navigate to the repository: [WebHosting](https://git.psi.ch/linux-infra/WebHosting) + +2. **Prepare Your Service** + - Ensure your service is running in a Docker container. + +3. **Edit the Docker Configuration** + - Update the `docker-compose.yaml` file 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`). + +4. **Create a Merge Request** + - Submit a merge request in the WebHosting repository: [WebHosting](https://git.psi.ch/linux-infra/WebHosting) + +5. **Contact Linux Engineering for Merge Approval** + - Email [linux-eng](mailto:linux-eng@psi.ch) to request the merge of your branch after review. + - The team will handle certificate creation post-review. + +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. + +- **Backup Schedule** + - Logbooks are backed up hourly, retained for one week. + - Other web content is backed up four times daily. + +- **Running Multiple Containers** + - For services needing multiple containers, we can create additional networks upon request. +