🐑 Sheep-Service Керівництво з установки

Повне покрокове керівництво для будь-якого користувача, щоб запустити Sheep-Service на своєму сервері або локальній машині.

---

🔗 Зміст

1. Початок
2. Встановлення Docker
3. Встановлення Docker Compose
4. Запуск Sheep-Service
5. Встановлення NGINX
6. Налаштування IP адреси CloudFlare
7. Налаштування NGINX для веб
8. Встановлення Certbot
9. CRONTAB Backup

---

1. Початок

Оновлення системи та встановлення необхідних пакетів:

sudo apt update && sudo apt upgrade -y
sudo apt install -y curl gnupg2 ca-certificates lsb-release zip

💡 Порада: завжди запускайте оновлення перед встановленням нових пакетів, щоб уникнути конфліктів.

---

2. Встановлення Docker

sudo apt install -y docker.io
sudo systemctl enable --now docker
sudo usermod -aG docker $USER

Примітка: Після додавання користувача до групи docker потрібно перелогінитися або виконати newgrp docker.

✅ Документація Docker

---

3. Встановлення Docker Compose

sudo apt install -y docker-compose
docker-compose --version

✅ Документація Docker Compose

---

4. Запуск Sheep-Service

Перехід в директорію проекту

cd /home/username/webapps/sheep-service.com

Запуск сервісів через Docker Compose

docker-compose pull
docker-compose -p sheep-service up --build -d api ws web

Запуск з вбудованим NGINX

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

sudo apt install nginx
sudo systemctl enable --now nginx
sudo systemctl status nginx

Редагування основного конфігураційного файлу:

sudo nano /etc/nginx/nginx.conf

Приклад налаштувань:

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

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;
set_real_ip_from 104.16.0.0/13;
set_real_ip_from 104.24.0.0/14;
set_real_ip_from 108.162.192.0/18;
set_real_ip_from 131.0.72.0/22;
set_real_ip_from 141.101.64.0/18;
set_real_ip_from 162.158.0.0/15;
set_real_ip_from 172.64.0.0/13;
set_real_ip_from 173.245.48.0/20;
set_real_ip_from 188.114.96.0/20;
set_real_ip_from 190.93.240.0/20;
set_real_ip_from 197.234.240.0/22;
set_real_ip_from 198.41.128.0/17;
set_real_ip_from 2400:cb00::/32;
set_real_ip_from 2606:4700::/32;
set_real_ip_from 2803:f800::/32;
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 X-Forwarded-For;

💡 Порада: Це дозволяє серверу отримувати реальні IP користувачів, якщо ви використовуєте CloudFlare.

---

7. Налаштування NGINX для веб

Створення файлу конфігурації сайту

sudo nano /etc/nginx/sites-available/sheep-service.com

Приклад конфігурації

server {
    listen 80;
    listen [::]:80;

    server_name sheep-service.com www.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|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 Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

        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;
        }
    }

    # 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 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 $host;
        proxy_set_header X-Real-IP $remote_addr;

        if ($request_method = 'GET') {
            add_header 'Access-Control-Allow-Origin' '*' always;
            add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, OPTIONS' always;
            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range' always;
            add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;
        }
    }
}

Активація сайту

sudo ln -s /etc/nginx/sites-available/sheep-service.com /etc/nginx/sites-enabled/sheep-service.com
sudo nginx -t
sudo systemctl reload nginx

---

8. Встановлення Certbot

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:

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

---

9. CRONTAB Backup

Редагування cron для резервного копіювання бази даних:

crontab -e

Додати завдання:

#####################
# Щоденне збереження резервної копії бази 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-залежностей:

sudo pip3 install python-dotenv

💡 Порада: Переконайтесь, що всі шляхи до директорій відповідають вашому користувачу та що всі сервіси працюють після перезавантаження Docker або сервера.