updating the documentation of the SilverLinux Insftracture

2026-06-21 13:35:59 +03:30
parent b43f2b790e
commit a8e23d3036
33 changed files with 3894 additions and 153 deletions
@@ -1,45 +1,122 @@
 # SilverLinux Infrastructure

-This repository contains the infrastructure configuration and documentation for the SilverLinux server.
+This repository contains the infrastructure configuration, deployment files and operational documentation for the SilverLinux server.

-## Services
+SilverLinux is the primary self-hosted platform for Silver Solutions and hosts source control, project management, collaboration, communication and future CI/CD services.
+
+---
+
+## Server Information
+
+| Property         | Value                   |
+| ---------------- | ----------------------- |
+| Hostname         | silverlinux             |
+| Provider         | OVH                     |
+| Operating System | Ubuntu Server 24.04 LTS |
+| Public IP        | 51.255.83.140           |
+| CPU              | Intel Xeon-D 1520       |
+| Memory           | 32 GB RAM               |
+| Storage          | 2 × 480 GB SSD RAID1    |
+
+---
+
+## Core Services

 ### Running

+* PostgreSQL
 * Gitea
+* OpenProject
+* Jitsi Meet
 * Portainer
-* Nginx Reverse Proxy
+* Nginx Proxy Manager

 ### Planned

 * BaGet
-* Plane.so
+* Sentry
+* CI/CD Runners
+* Nextcloud
+
+### Removed
+
+* Plane.so (replaced by OpenProject)
+
+---
+
+## Shared Infrastructure
+
+The following components are shared across multiple services:
+
+* Docker
+* Docker Compose
+* Internal Docker Network
+* Proxy Docker Network
+* Shared Secrets Management
+
+Secrets are stored outside the repository:
+
+```text
+/srv/secrets/company.env
+```
+
+---
+
+## Repository Structure
+
+```text
+docs/
+gitea/
+jitsi/
+nginx-proxy-manager/
+openproject/
+portainer/
+postgres/
+scripts/
+```
+
+Each service folder contains:
+
+* docker-compose.yml
+* README.md
+* .env.example
+
+---

 ## Purpose

 This repository serves as the single source of truth for rebuilding and maintaining the SilverLinux environment.

-Infrastructure documentation, Docker Compose files, reverse proxy configuration, backup procedures, and deployment notes are stored here.
+Infrastructure documentation, Docker Compose files, backup procedures, deployment notes and operational decisions are stored here.

-## Server
+The goal is that the entire environment can be rebuilt from this repository and the documented backup files.

-* Hostname: silverlinux
-* OS: Ubuntu Server 24.04 LTS
-* Provider: OVH
+---

-## Important
+## Security

-Do not commit:
+Never commit:

 * Passwords
 * API Keys
 * SMTP Credentials
+* OAuth Secrets
 * SSL Private Keys
 * Database Credentials
 * Real `.env` files
+* `/srv/secrets/company.env`

-Use `.env.example` files instead.
+Use example files whenever possible.
+
+---

 ## Disaster Recovery

-This repository should contain enough configuration and documentation to rebuild the SilverLinux environment from scratch.
+This repository should contain enough information to rebuild the entire SilverLinux environment from scratch.
+
+See:
+
+* docs/server.md
+* docs/backups.md
+* docs/security.md
+* docs/secrets.md