diff --git a/README.md b/README.md index 20a8747..00435cb 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,115 @@ -# Start +# 🐑 Sheep-Service Керівництво з установки -``` -sudo apt update +> Повне покрокове керівництво для будь-якого користувача, щоб запустити Sheep-Service на своєму сервері або локальній машині. + +--- + +## 🔗 Зміст + +1. [Початок](#1-початок) +2. [Встановлення Docker](#2-встановлення-docker) +3. [Встановлення Docker Compose](#3-встановлення-docker-compose) +4. [Запуск Sheep-Service](#4-запуск-sheep-service) +5. [Встановлення NGINX](#5-встановлення-nginx) +6. [Налаштування IP адреси CloudFlare](#6-налаштування-ip-адреси-cloudflare) +7. [Налаштування NGINX для веб](#7-налаштування-nginx-для-веб) +8. [Встановлення Certbot](#8-встановлення-certbot) +9. [CRONTAB Backup](#9-crontab-backup) + +--- + +## 1. Початок + +Оновлення системи та встановлення необхідних пакетів: + +```bash +sudo apt update && sudo apt upgrade -y +sudo apt install -y curl gnupg2 ca-certificates lsb-release zip ``` -``` -sudo apt upgrade -y -``` +💡 **Порада:** завжди запускайте оновлення перед встановленням нових пакетів, щоб уникнути конфліктів. -``` -sudo apt install -y curl gnupg2 ca-certificates lsb-release -``` +--- -``` -sudo apt install zip -``` +## 2. Встановлення Docker -
-
- -# Docker Install - -``` -sudo apt update +```bash sudo apt install -y docker.io sudo systemctl enable --now docker sudo usermod -aG docker $USER ``` -
-
+> **Примітка:** Після додавання користувача до групи `docker` потрібно перелогінитися або виконати `newgrp docker`. -# Docker Compose Install +✅ [Документація Docker](https://docs.docker.com/engine/install/ubuntu/) -``` +--- + +## 3. Встановлення Docker Compose + +```bash sudo apt install -y docker-compose -``` - -``` docker-compose --version ``` -
-
+✅ [Документація Docker Compose](https://docs.docker.com/compose/install/) -# Start Sheep-Service +--- -``` -cd /home/rozenrod/webapps/sheep-service.com +## 4. Запуск Sheep-Service + +### Перехід в директорію проекту + +```bash +cd /home/username/webapps/sheep-service.com ``` -``` -cd /home/rozenrod/webapps/sheep-service.com && docker-compose pull && docker-compose -p sheep-service up --build -d api ws web -``` -or +### Запуск сервісів через Docker Compose -``` -cd /home/rozenrod/webapps/sheep-service.com && docker-compose pull && docker-compose --profile with-nginx -p sheep-service up --build -d +```bash +docker-compose pull +docker-compose -p sheep-service up --build -d api ws web ``` -
-
- -# NGINX Install +### Запуск з вбудованим NGINX +```bash +docker-compose --profile with-nginx -p sheep-service up --build -d ``` + +💡 **Важливо:** Команду `docker-compose --profile with-nginx ...` використовують тільки якщо на сервері **не встановлений та не планується встановлення NGINX**. В цьому випадку буде запущений **вбудований NGINX на порті 80**, і **не потрібно встановлювати окремо NGINX та Certbot**. + +💡 **Порада:** Перевірте, що порти 4000, 4001, 4002 відкриті або перенаправлені на сервері. + +--- + +## 5. Встановлення NGINX + +```bash sudo apt install nginx -``` - -``` +sudo systemctl enable --now nginx sudo systemctl status nginx ``` -``` -sudo systemctl enable nginx -``` +Редагування основного конфігураційного файлу: -``` +```bash sudo nano /etc/nginx/nginx.conf ``` -``` -proxy_cache_path /etc/nginx/cache levels=1:2 keys_zone=all:5m inactive=10m max_size=2g; +Приклад налаштувань: +```nginx +proxy_cache_path /etc/nginx/cache levels=1:2 keys_zone=all:5m inactive=10m max_size=2g; limit_req_zone $binary_remote_addr zone=one:5m rate=30r/s; client_max_body_size 20M; ``` -
-
+--- -``` +## 6. Налаштування IP адреси CloudFlare + +```nginx set_real_ip_from 103.21.244.0/22; set_real_ip_from 103.22.200.0/22; set_real_ip_from 103.31.4.0/22; @@ -113,99 +132,87 @@ set_real_ip_from 2405:b500::/32; set_real_ip_from 2405:8100::/32; set_real_ip_from 2a06:98c0::/29; set_real_ip_from 2c0f:f248::/32; - -#real_ip_header CF-Connecting-IP; real_ip_header X-Forwarded-For; ``` -
-
+💡 **Порада:** Це дозволяє серверу отримувати реальні IP користувачів, якщо ви використовуєте CloudFlare. -# NGINX Settings WEB +--- -``` +## 7. Налаштування NGINX для веб + +### Створення файлу конфігурації сайту + +```bash sudo nano /etc/nginx/sites-available/sheep-service.com ``` -``` +### Приклад конфігурації + +```nginx server { listen 80; listen [::]:80; server_name sheep-service.com www.sheep-service.com; - error_log /home/rozenrod/webapps/log/sheep-service.com.error.log error; - access_log /home/rozenrod/webapps/log/sheep-service.com.access.log; - - root /home/rozenrod/webapps/sheep-service.com; + error_log /home/username/webapps/log/sheep-service.com.error.log error; + access_log /home/username/webapps/log/sheep-service.com.access.log; + root /home/username/webapps/sheep-service.com; index index.html; - error_page 404 /404.html; - location ~ /\.git { + # Захист службових файлів + location ~ /\.(git|env) { deny all; } - location ~ /\.env { - deny all; + # Загальні CORS-заголовки + map $request_method $cors_preflight { + OPTIONS 1; + default 0; } + # API location /api/ { proxy_pass http://127.0.0.1:4000; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "Upgrade"; + proxy_set_header Connection "upgrade"; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - if ($request_method = 'OPTIONS') { - add_header 'Access-Control-Allow-Origin' '*'; - add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS'; - add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization'; + add_header 'Access-Control-Allow-Origin' '*' always; + add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS' always; + add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization' always; + add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always; + + if ($cors_preflight) { add_header 'Access-Control-Max-Age' 1728000; add_header 'Content-Type' 'text/plain; charset=utf-8'; add_header 'Content-Length' 0; return 204; } - if ($request_method = 'PUT') { - add_header 'Access-Control-Allow-Origin' '*' always; - add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS' always; - add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization' always; - add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always; - } - if ($request_method = 'POST') { - add_header 'Access-Control-Allow-Origin' '*' always; - add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS' always; - add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization' always; - add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always; - } - if ($request_method = 'GET') { - add_header 'Access-Control-Allow-Origin' '*' always; - add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS' always; - add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization' always; - add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always; - } - if ($request_method = 'DELETE') { - add_header 'Access-Control-Allow-Origin' '*' always; - add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS' always; - add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization' always; - add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always; - } } + # WebSocket location /ws { proxy_pass http://127.0.0.1:4001; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "Upgrade"; + proxy_set_header Connection "upgrade"; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; } + # Frontend location / { proxy_pass http://127.0.0.1:4002; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "Upgrade"; - proxy_set_header Host $http_host; + proxy_set_header Connection "upgrade"; + proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; if ($request_method = 'GET') { @@ -216,76 +223,61 @@ server { } } } - ``` -``` +### Активація сайту + +```bash sudo ln -s /etc/nginx/sites-available/sheep-service.com /etc/nginx/sites-enabled/sheep-service.com -``` - -``` sudo nginx -t -``` - -``` sudo systemctl reload nginx ``` -
-
+--- -# Certbot Install +## 8. Встановлення Certbot -``` +```bash sudo python3 -m venv /opt/certbot/ -``` - -``` sudo /opt/certbot/bin/pip install --upgrade pip -``` - -``` sudo /opt/certbot/bin/pip install certbot certbot-nginx -``` - -``` sudo ln -s /opt/certbot/bin/certbot /usr/bin/certbot -``` - -``` sudo certbot --nginx -d sheep-service.com ``` +Автоматичне оновлення сертифікатів через cron: -``` +```bash echo "0 0,12 * * * root /opt/certbot/bin/python -c 'import random; import time; time.sleep(random.random() * 3600)' && sudo certbot renew -q" | sudo tee -a /etc/crontab > /dev/null -``` - -``` sudo /opt/certbot/bin/pip install --upgrade certbot certbot-nginx ``` -
-
+✅ [Документація Certbot](https://certbot.eff.org/) -# CRONTAB +--- - -``` -crontab -e +## 9. CRONTAB Backup + +Редагування cron для резервного копіювання бази даних: + +```bash +crontab -e ``` - -``` +Додати завдання: + +```cron ##################### -# Script for saving a backup copy of the Sheep-Service database every day at 22:30 -30 22 * * * cd /home/rozenrod/webapps/sheep-service.com && /usr/bin/python3 backup.py >> /home/rozenrod/webapps/sheep-service.com/log/backup.log 2>&1 +# Щоденне збереження резервної копії бази Sheep-Service о 22:30 +30 22 * * * cd /home/username/webapps/sheep-service.com && /usr/bin/python3 backup.py >> /home/username/webapps/sheep-service.com/log/backup.log 2>&1 ##################### ``` -``` +Встановлення Python-залежностей: + +```bash sudo pip3 install python-dotenv ``` -
-
\ No newline at end of file +💡 **Порада:** Переконайтесь, що всі шляхи до директорій відповідають вашому користувачу та що всі сервіси працюють після перезавантаження Docker або сервера. +