install/cryptpad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation..

Browse Source
This commit is contained in:
Christoph
2022-09-22 14:32:29 +02:00
parent d686bcbc3a
commit cffe6dd69e
5 changed files with 440 additions and 410 deletions
Download Patch File Download Diff File Expand all files Collapse all files

309
README.install
View File

@ -61,305 +61,13 @@ apt-get install nginx
mkdir /etc/nginx/ssl
openssl dhparam -out /etc/nginx/ssl/dhparam.pem 2048
# ----------
# - Create nginx configuration for CryptPad
# -
cat <<EOF > /etc/nginx/sites-available/${vhost_config_file}
# we want restrict authentication to cryptpad sandbox urls "$cryptpad_sandbox_url"
#
#map \$http_host \$auth_type {
# default "off"; #This will turn off auth-basic
# $cryptpad_sandbox_url "Restricted"; #This or any other string will turn it back on
#}
server {
listen 80;
listen [::]:80;
server_name $cryptpad_url;
return 301 https://\$server_name\$request_uri;
}
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
# CryptPad serves static assets over these two domains.
# \`main_domain\` is what users will enter in their address bar.
# Privileged computation such as key management is handled in this scope
# UI content is loaded via the \`sandbox_domain\`.
# "Content Security Policy" headers prevent content loaded via the sandbox
# from accessing privileged information.
# These variables must be different to take advantage of CryptPad's sandboxing techniques.
# In the event of an XSS vulnerability in CryptPad's front-end code
# this will limit the amount of information accessible to attackers.
set \$main_domain "$cryptpad_url";
set \$sandbox_domain "$cryptpad_sandbox_url";
# CryptPad's dynamic content (websocket traffic and encrypted blobs)
# can be served over separate domains. Using dedicated domains (or subdomains)
# for these purposes allows you to move them to a separate machine at a later date
# if you find that a single machine cannot handle all of your users.
# If you don't use dedicated domains, this can be the same as $main_domain
# If you do, they'll be added as exceptions to any rules which block connections to remote domains.
set \$api_domain "$cryptpad_url";
set \$files_domain "$cryptpad_url";
EOF
if [[ "$cryptpad_url" = "$cryptpad_sandbox_url" ]]; then
cat <<EOF >> /etc/nginx/sites-available/${vhost_config_file}
server_name $cryptpad_url;
EOF
else
cat <<EOF >> /etc/nginx/sites-available/${vhost_config_file}
server_name $cryptpad_url $cryptpad_sandbox_url;
EOF
fi
cat <<EOF >> /etc/nginx/sites-available/${vhost_config_file}
ssl_certificate /var/lib/dehydrated/certs/$cryptpad_url/fullchain.pem;
ssl_certificate_key /var/lib/dehydrated/certs/$cryptpad_url/privkey.pem;
ssl_trusted_certificate /var/lib/dehydrated/certs/$cryptpad_url/chain.pem;
# - Needed for (automated) updating certificate
# -
include snippets/letsencrypt-acme-challenge.conf;
# Diffie-Hellman parameter for DHE ciphersuites, recommended 2048 bits
#
# To generate a dhparam.pem file, run in a terminal
# openssl dhparam -out /etc/nginx/ssl/dhparam.pem 2048
#
ssl_dhparam /etc/nginx/ssl/dhparam.pem;
# Speeds things up a little bit when resuming a session
ssl_session_timeout 5m;
ssl_session_cache shared:SSL_CP:5m;
# You'll need nginx 1.13.0 or better to support TLSv1.3
ssl_protocols TLSv1.2 TLSv1.3;
ssl_ciphers EECDH+AESGCM:EDH+AESGCM;
ssl_ecdh_curve secp384r1; # Requires nginx >= 1.1.0
add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
add_header X-XSS-Protection "1; mode=block";
add_header X-Content-Type-Options nosniff;
add_header Access-Control-Allow-Origin "*";
# add_header X-Frame-Options "SAMEORIGIN";
# Nginx Bad Bot Blocker Includes
#include /etc/nginx/bots.d/ddos.conf;
#include /etc/nginx/bots.d/blockbots.conf;
#if (\$allowed_country = no) {
# set \$blockreason '[geo_blocked]';
# return 403;
#}
#if ( \$bad_querystring !~* "\[OK\]" ) {
# set \$blockreason \$bad_querystring;
# return 403;
#}
#if ( \$bad_request !~* "\[OK\]" ) {
# set \$blockreason \$bad_request;
# return 403;
#}
#if ( \$bad_request_method !~* "\[OK\]" ) {
# set \$blockreason \$bad_request_method;
# return 403;
#}
# End Bad Bot Blocker Includes
# Opt out of Google's FLoC Network
add_header Permissions-Policy interest-cohort=();
EOF
cat <<EOF >> /etc/nginx/sites-available/${vhost_config_file}
set \$coop '';
#if (\$uri ~ ^\/(sheet|presentation|doc|convert)\/.*\$) { set \$coop 'same-origin'; }
# Enable SharedArrayBuffer in Firefox (for .xlsx export)
add_header Cross-Origin-Resource-Policy cross-origin;
add_header Cross-Origin-Opener-Policy \$coop;
add_header Cross-Origin-Embedder-Policy require-corp;
# Insert the path to your CryptPad repository root here
root /var/www/cryptpad;
index index.html;
error_page 404 /customize.dist/404.html;
# any static assets loaded with "ver=" in their URL will be cached for a year
if (\$args ~ ver=) {
set \$cacheControl max-age=31536000;
}
if (\$uri ~ ^/.*(\/|\.html)\$) {
set \$cacheControl no-cache;
}
# Will not set any header if it is emptystring
add_header Cache-Control \$cacheControl;
# CSS can be dynamically set inline, loaded from the same domain, or from \$main_domain
set \$styleSrc "'unsafe-inline' 'self' \${main_domain}";
# connect-src restricts URLs which can be loaded using script interfaces
set \$connectSrc "'self' https://\${main_domain} \${main_domain} https://\${api_domain} blob: wss://\${api_domain} \${api_domain} \${files_domain} https://\${sandbox_domain}";
# fonts can be loaded from data-URLs or the main domain
set \$fontSrc "'self' data: \${main_domain}";
# images can be loaded from anywhere, though we'd like to deprecate this as it allows the use of images for tracking
set \$imgSrc "'self' data: * blob: \${main_domain}";
# frame-src specifies valid sources for nested browsing contexts.
# this prevents loading any iframes from anywhere other than the sandbox domain
set \$frameSrc "'self' \${sandbox_domain} blob:";
# specifies valid sources for loading media using video or audio
set \$mediaSrc "'self' data: * blob: \${main_domain}";
# defines valid sources for webworkers and nested browser contexts
# deprecated in favour of worker-src and frame-src
set \$childSrc "https://\${main_domain}";
# specifies valid sources for Worker, SharedWorker, or ServiceWorker scripts.
# supercedes child-src but is unfortunately not yet universally supported.
set \$workerSrc "https://\${main_domain}";
# script-src specifies valid sources for javascript, including inline handlers
set \$scriptSrc "'self' resource: \${main_domain}";
set \$unsafe 0;
# the following assets are loaded via the sandbox domain
# they unfortunately still require exceptions to the sandboxing to work correctly.
if (\$uri ~ ^\/(sheet|doc|presentation)\/inner.html.*\$) { set \$unsafe 1; }
if (\$uri ~ ^\/common\/onlyoffice\/.*\/.*\.html.*\$) { set \$unsafe 1; }
# everything except the sandbox domain is a privileged scope, as they might be used to handle keys
if (\$host != \$sandbox_domain) { set \$unsafe 0; }
# this iframe is an exception. Office file formats are converted outside of the sandboxed scope
# because of bugs in Chromium-based browsers that incorrectly ignore headers that are supposed to enable
# the use of some modern APIs that we require when javascript is run in a cross-origin context.
# We've applied other sandboxing techniques to mitigate the risk of running WebAssembly in this privileged scope
if (\$uri ~ ^\/unsafeiframe\/inner\.html.*\$) { set \$unsafe 1; }
EOF
cat <<EOF >> /etc/nginx/sites-available/${vhost_config_file}
# privileged contexts allow a few more rights than unprivileged contexts, though limits are still applied
if (\$unsafe) {
set \$scriptSrc "'self' 'unsafe-eval' 'unsafe-inline' resource: \${main_domain}";
}
# Finally, set all the rules you composed above.
add_header Content-Security-Policy "default-src 'none'; child-src \$childSrc; worker-src \$workerSrc; media-src \$mediaSrc; style-src \$styleSrc; script-src \$scriptSrc; connect-src \$connectSrc; font-src \$fontSrc; img-src \$imgSrc; frame-src \$frameSrc;";
# The nodejs process can handle all traffic whether accessed over websocket or as static assets
# We prefer to serve static content from nginx directly and to leave the API server to handle
# the dynamic content that only it can manage. This is primarily an optimization
location ^~ /cryptpad_websocket {
proxy_pass http://localhost:3000;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header Host \$host;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
# WebSocket support (nginx 1.4)
proxy_http_version 1.1;
proxy_set_header Upgrade \$http_upgrade;
proxy_set_header Connection upgrade;
}
location ^~ /customize.dist/ {
# This is needed in order to prevent infinite recursion between /customize/ and the root
}
# try to load customizeable content via /customize/ and fall back to the default content
# located at /customize.dist/
# This is what allows you to override behaviour.
location ^~ /customize/ {
rewrite ^/customize/(.*)\$ \$1 break;
try_files /customize/\$uri /customize.dist/\$uri;
}
# /api/config is loaded once per page load and is used to retrieve
# the caching variable which is applied to every other resource
# which is loaded during that session.
location ~ ^/api/(config|broadcast).*\$ {
proxy_pass http://localhost:3000;
proxy_set_header X-Real-IP \$remote_addr;
proxy_set_header Host \$host;
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
# These settings prevent both NGINX and the API server
# from setting the same headers and creating duplicates
proxy_hide_header Cross-Origin-Resource-Policy;
add_header Cross-Origin-Resource-Policy cross-origin;
proxy_hide_header Cross-Origin-Embedder-Policy;
add_header Cross-Origin-Embedder-Policy require-corp;
}
# encrypted blobs are immutable and are thus cached for a year
location ^~ /blob/ {
if (\$request_method = 'OPTIONS') {
add_header 'Access-Control-Allow-Origin' '*';
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range';
add_header 'Access-Control-Max-Age' 1728000;
add_header 'Content-Type' 'application/octet-stream; charset=utf-8';
add_header 'Content-Length' 0;
return 204;
}
add_header Cache-Control max-age=31536000;
add_header 'Access-Control-Allow-Origin' '*';
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,Content-Length';
add_header 'Access-Control-Expose-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Content-Range,Range,Content-Length';
try_files \$uri =404;
}
EOF
cat <<EOF >> /etc/nginx/sites-available/${vhost_config_file}
# the "block-store" serves encrypted payloads containing users' drive keys
# these payloads are unlocked via login credentials. They are mutable
# and are thus never cached. They're small enough that it doesn't matter, in any case.
location ^~ /block/ {
add_header Cache-Control max-age=0;
try_files \$uri =404;
}
# This block provides an alternative means of loading content
# otherwise only served via websocket. This is solely for debugging purposes,
# and is thus not allowed by default.
#location ^~ /datastore/ {
#add_header Cache-Control max-age=0;
#try_files \$uri =404;
#}
# The nodejs server has some built-in forwarding rules to prevent
# URLs like /pad from resulting in a 404. This simply adds a trailing slash
# to a variety of applications.
location ~ ^/(register|login|settings|user|pad|drive|poll|slide|code|whiteboard|file|media|profile|contacts|todo|filepicker|debug|kanban|sheet|support|admin|notifications|teams|calendar|presentation|doc|form|report|convert)\$ {
rewrite ^(.*)\$ \$1/ redirect;
}
# Finally, serve anything the above exceptions don't govern.
try_files /www/\$uri /www/\$uri/index.html /customize/\$uri;
# Only authenticated users
#
#auth_basic "\$auth_type";
#auth_basic_user_file /etc/nginx/.htpasswd-${cryptpad_url%%.*};
}
EOF
# - see: https://github.com/xwiki-labs/cryptpad/blob/main/docs/example.nginx.conf
# -
# ----------
# ---
@ -604,3 +312,10 @@ systemctl start cryptpad
#
# https://${cryptpad_url}/checkup/
# Maybe the the 'checkup' script recommends to run:
#
# npm run build
#
# we have to do this under the webservice user www-data
#
su www-data -s /bin/bash -c "npm run build"