diff --git a/README.md b/README.md index bb30731b7..032a90789 100644 --- a/README.md +++ b/README.md @@ -44,17 +44,15 @@ This guide will work for both **starting from scratch** and **migrating from Mis ## ๐Ÿ“ฆ Dependencies -- At least ๐Ÿข NodeJS v16.15.0 (v18.12.1 recommended) +- At least ๐Ÿข [NodeJS](https://nodejs.org/en/) v16.15.0 (v18.12.1 recommended) > โš ๏ธ NodeJS v19 is not supported as of right now because of [this issue](https://github.com/nodejs/node-gyp/issues/2757). -- ๐Ÿงถ At least Yarn v3 +- ๐Ÿ˜ At least [PostgreSQL](https://www.postgresql.org/) v12 -- ๐Ÿ˜ At least PostgreSQL v12 +- ๐Ÿฑ At least [Redis](https://redis.io/) v6 (v7 recommended) -- ๐Ÿฑ At least Redis v6 (v7 recommended) - -- ๐Ÿ›ฐ๏ธ (Optional, for non-Docker) pm2 +- ๐Ÿ›ฐ๏ธ (Optional, for non-Docker) [pm2](https://pm2.io/) ## ๐Ÿ‘€ Get folder ready @@ -87,7 +85,85 @@ cp -r ../misskey/files . # if you don't use object storage ## ๐Ÿ€ NGINX -Read +
+Click to see an example NGINX config: + +```nginx +# Replace example.tld with your domain + +# For WebSocket +map $http_upgrade $connection_upgrade { + default upgrade; + '' close; +} + +proxy_cache_path /tmp/nginx_cache levels=1:2 keys_zone=cache1:16m max_size=1g inactive=720m use_temp_path=off; + +server { + listen 80; + listen [::]:80; + server_name example.tld; + + # For SSL domain validation + root /var/www/html; + location /.well-known/acme-challenge/ { allow all; } + location /.well-known/pki-validation/ { allow all; } + location / { return 301 https://$server_name$request_uri; } +} + +server { + listen 443 ssl http2; + listen [::]:443 ssl http2; + server_name example.tld; + + ssl_session_timeout 1d; + ssl_session_cache shared:ssl_session_cache:10m; + ssl_session_tickets off; + + # To use Let's Encrypt certificate + ssl_certificate /etc/letsencrypt/live/example.tld/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/example.tld/privkey.pem; + + # To use Debian/Ubuntu's self-signed certificate (For testing or before issuing a certificate) + #ssl_certificate /etc/ssl/certs/ssl-cert-snakeoil.pem; + #ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key; + + # SSL protocol settings + ssl_protocols TLSv1.2 TLSv1.3; + ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384; + ssl_prefer_server_ciphers off; + ssl_stapling on; + ssl_stapling_verify on; + + # Change to your upload limit + client_max_body_size 80m; + + # Proxy to Node + location / { + proxy_pass http://127.0.0.1:3939; + proxy_set_header Host $host; + proxy_http_version 1.1; + proxy_redirect off; + + # If it's behind another reverse proxy or CDN, remove the following. + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto https; + + # For WebSocket + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; + + # Cache settings + proxy_cache cache1; + proxy_cache_lock on; + proxy_cache_use_stale updating; + add_header X-Cache $upstream_cache_status; + } +} +``` + +
## ๐Ÿš€ Build and launch!