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

Update Install/Upgrade docu..

Browse Source
This commit is contained in:
Christoph 2021-04-06 03:16:06 +02:00
parent 746ffcfa44
commit 93192ba1b1
2 changed files with 222 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.copy-userdata-to-new-installation
View File

@ -6,4 +6,4 @@
backup_date="2019-11-03-0036" backup_date="2019-11-03-0036"
cp -a /var/www/cryptpad.BAK.${backup_date}/{blob,blobstage,block,datastore} /var/www/cryptpad/ cp -a /var/www/cryptpad.BAK.${backup_date}/{blob,blobstage,block,datastore} /var/www/cryptpad/cryptpad/

306
README.install
View File

@ -10,6 +10,9 @@
# - installation guide: https://github.com/xwiki-labs/cryptpad/wiki/Installation-guide # - installation guide: https://github.com/xwiki-labs/cryptpad/wiki/Installation-guide
# - # -
cryptpad_url=cpad-01.oopen.de
cryptpad_sandbox_url=cpadsb-01.oopen.de
# ---------- # ----------
# - Pre-requisites # - Pre-requisites
@ -46,9 +49,8 @@ openssl dhparam -out /etc/nginx/ssl/dhparam.pem 2048
# - Create nginx configuration for CryptPad # - Create nginx configuration for CryptPad
# - # -
cryptpad_url=cpad-01.oopen.de
cat <<EOF > cpad-01.oopen.de.conf cat <<EOF > /etc/nginx/sites-available/cpad-01.oopen.de.conf
# -- $cryptpad_url # -- $cryptpad_url
server { server {
@ -63,11 +65,32 @@ server {
listen 443 ssl http2; listen 443 ssl http2;
listen [::]:443 ssl http2; listen [::]:443 ssl http2;
server_name $cryptpad_url; # 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_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";
server_name $cryptpad_url $cryptpad_sandbox_url;
ssl_certificate /var/lib/dehydrated/certs/$cryptpad_url/fullchain.pem; ssl_certificate /var/lib/dehydrated/certs/$cryptpad_url/fullchain.pem;
ssl_certificate_key /var/lib/dehydrated/certs/$cryptpad_url/privkey.pem; ssl_certificate_key /var/lib/dehydrated/certs/$cryptpad_url/privkey.pem;
#ssl_trusted_certificate /var/lib/dehydrated/certs/$cryptpad_url/fullchain.pem; ssl_trusted_certificate /var/lib/dehydrated/certs/$cryptpad_url/chain.pem;
# - Needed for (automated) updating certificate # - Needed for (automated) updating certificate
# - # -
@ -81,76 +104,121 @@ server {
# #
ssl_dhparam /etc/nginx/ssl/dhparam.pem; 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;
# Eable session resumption to improve https performance # You'll need nginx 1.13.0 or better to support TLSv1.3
ssl_session_cache shared:SSL:50m; ssl_protocols TLSv1.2 TLSv1.3;
ssl_session_timeout 10m;
ssl_session_tickets off;
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_protocols TLSv1 TLSv1.1 TLSv1.2; # omit SSLv3 because of POODLE ssl_ecdh_curve secp384r1; # Requires nginx >= 1.1.0
# ECDHE better than DHE (faster) ECDHE & DHE GCM better than CBC (attacks on AES) add_header Strict-Transport-Security "max-age=31536000; includeSubDomains" always;
# Everything better than SHA1 (deprecated)
#
ssl_ciphers 'ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA';
ssl_prefer_server_ciphers on;
add_header Strict-Transport-Security "max-age=31536000" always;
add_header X-XSS-Protection "1; mode=block"; add_header X-XSS-Protection "1; mode=block";
add_header X-Content-Type-Options nosniff; add_header X-Content-Type-Options nosniff;
#add_header X-Frame-Options "SAMEORIGIN"; add_header Access-Control-Allow-Origin "*";
# add_header X-Frame-Options "SAMEORIGIN";
root /var/www/cryptpad; # 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
set \$coop '';
if (\$uri ~ ^\/sheet\/.*\$) { set \$coop 'same-origin'; }
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/cryptpad;
index index.html; index index.html;
error_page 404 /customize.dist/404.html; error_page 404 /customize.dist/404.html;
if (\$args ~ ver=) { # any static assets loaded with "ver=" in their URL will be cached for a year
set \$cacheControl max-age=31536000; if (\$args ~ ver=) {
} set \$cacheControl max-age=31536000;
# Will not set any header if it is emptystring }
# if (\$uri ~ ^/.*(\/|\.html)\$) {
add_header Cache-Control \$cacheControl; set \$cacheControl no-cache;
}
# Will not set any header if it is emptystring
add_header Cache-Control \$cacheControl;
# - Does not work with CKEditor and OnlyOffice # CSS can be dynamically set inline, loaded from the same domain, or from \$main_domain
# - set \$styleSrc "'unsafe-inline' 'self' \${main_domain}";
#set \$styleSrc "'unsafe-inline' 'self' $cryptpad_url";
#set \$scriptSrc "'self' $cryptpad_url";
#set \$connectSrc "'self' https://$cryptpad_url wss://$cryptpad_url $cryptpad_url https://api.$cryptpad_url blob: $cryptpad_url";
#set \$fontSrc "'self' data: $cryptpad_url";
#set \$imgSrc "'self' data: * blob: $cryptpad_url";
#set \$frameSrc "'self' $cryptpad_url blob: $cryptpad_url";
#set \$mediaSrc "'self' data: * blob: $cryptpad_url";
#set \$childSrc "https://$cryptpad_url";
#set \$workerSrc "https://$cryptpad_url";
#
#set \$unsafe 0;
#if (\$uri = "/pad/inner.html") { set \$unsafe 1; }
#if (\$uri = "/sheet/inner.html") { set \$unsafe 1; }
#if (\$uri = "/common/onlyoffice/web-apps/apps/spreadsheeteditor/main/index.html") { set \$unsafe 1; }
#if (\$host != sandbox.cryptpad.info) { set \$unsafe 0; }
#if (\$unsafe) {
# set \$scriptSrc "'self' 'unsafe-eval' 'unsafe-inline' $cryptpad_url";
#}
# 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}";
# - Make CKEditor and OnlyOffice working # fonts can be loaded from data-URLs or the main domain
# - set \$fontSrc "'self' data: \${main_domain}";
# - See /var/www/cryptpad/config.js (contentSecurity,padContentSecurity, ooContentSecurity)
# -
set \$styleSrc "'unsafe-inline' 'self' $cryptpad_url";
set \$scriptSrc "'self' 'unsafe-eval' 'unsafe-inline' $cryptpad_url";
set \$connectSrc "'self' ws: wss: $cryptpad_url";
set \$fontSrc "'self' data: $cryptpad_url";
set \$imgSrc " * blob:";
set \$frameSrc "*";
set \$mediaSrc "'self' data: * blob: $cryptpad_url";
set \$childSrc *;
set \$workerSrc "https://$cryptpad_url";
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;"; # 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/inner.html") { set \$unsafe 1; }
if (\$uri ~ ^\/common\/onlyoffice\/.*\/index\.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; }
# 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 { location ^~ /cryptpad_websocket {
proxy_pass http://localhost:3000; proxy_pass http://localhost:3000;
proxy_set_header X-Real-IP \$remote_addr; proxy_set_header X-Real-IP \$remote_addr;
@ -166,11 +234,17 @@ server {
location ^~ /customize.dist/ { location ^~ /customize.dist/ {
# This is needed in order to prevent infinite recursion between /customize/ and the root # 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/ { location ^~ /customize/ {
rewrite ^/customize/(.*)\$ \$1 break; rewrite ^/customize/(.*)\$ \$1 break;
try_files /customize/\$uri /customize.dist/\$uri; 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 { location = /api/config {
proxy_pass http://localhost:3000; proxy_pass http://localhost:3000;
proxy_set_header X-Real-IP \$remote_addr; proxy_set_header X-Real-IP \$remote_addr;
@ -178,27 +252,50 @@ server {
proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
} }
# encrypted blobs are immutable and are thus cached for a year
location ^~ /blob/ { 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 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; try_files \$uri =404;
} }
# 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/ { location ^~ /block/ {
add_header Cache-Control max-age=0; add_header Cache-Control max-age=0;
try_files \$uri =404; try_files \$uri =404;
} }
location ^~ /datastore/ { # This block provides an alternative means of loading content
add_header Cache-Control max-age=0; # otherwise only served via websocket. This is solely for debugging purposes,
try_files \$uri =404; # and is thus not allowed by default.
} #location ^~ /datastore/ {
#add_header Cache-Control max-age=0;
#try_files \$uri =404;
#}
location ~ ^/(register|login|settings|user|pad|drive|poll|slide|code|whiteboard|file|media|profile|contacts|todo|filepicker|debug|kanban|sheet)\$ { # The nodejs server has some built-in forwarding rules to prevent
rewrite ^(.*)\$ \$1/ redirect; # 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)\$ {
try_files /www/\$uri /www/\$uri/index.html /customize/\$uri; rewrite ^(.*)\$ \$1/ redirect;
}
# Finally, serve anything the above exceptions don't govern.
try_files /www/\$uri /www/\$uri/index.html /customize/\$uri;
} }
EOF EOF
@ -276,6 +373,7 @@ node -v
npm -v npm -v
# --- # ---
# - Install bower # - Install bower
# --- # ---
@ -285,21 +383,24 @@ npm -v
npm install -g bower npm install -g bower
# ---
# - Create the user for the service:
# ---
mkdir /var/www/cryptpad
chown www-data:www-data /var/www/cryptpad
# --- # ---
# - Install cryptpad # - Install cryptpad
# --- # ---
cd /var/www cd /var/www/cryptpad
# - Create needed folders
# -
mkdir /var/www/{.cache,.config,.local,.node-gyp,.npm}
chown www-data:www-data /var/www/{.cache,.config,.local,.node-gyp,.npm}
# - Get cryptpad # - Get cryptpad
# - # -
git clone https://github.com/xwiki-labs/cryptpad su www-data -s /bin/bash -c "git clone https://github.com/xwiki-labs/cryptpad"
chown -R www-data:www-data cryptpad
cd cryptpad cd cryptpad
# - Complete Installation of cryptpad # - Complete Installation of cryptpad
@ -322,20 +423,28 @@ cp -a config/config.example.js config/config.js
# - Some base configuration # - Some base configuration
# - # -
# - adminEmail: 'admin.de', # - adminEmail: 'admin@oopen.de',
# - ...
# - httpAddress: '::',
# - ... # - ...
# - myDomain: oopen.de, # - myDomain: oopen.de,
# - # -
perl -i -n -p -e"s#(\s*)(adminEmail:.*)#\1// \2\n\1adminEmail: 'admin\@oopen.de',#" /var/www/cryptpad/config/config.js perl -i -n -p -e"s#(\s*)(adminEmail:.*)#\1// \2\n\1adminEmail: 'admin\@oopen.de',#" /var/www/cryptpad/cryptpad/config/config.js
perl -i -n -p -e"s#(\s*)(myDomain:.*)#\1// \2\n\1myDomain: oopen.de,#" /var/www/cryptpad/config/config.js
perl -i -n -p -e"s#(\s*)(httpUnsafeOrigin:.*)#\1// \2\n\1httpUnsafeOrigin: 'https://${cryptpad_url}',#" /var/www/cryptpad/cryptpad/config/config.js
perl -i -n -p -e"s#(\s*)(/*\s*)(httpSafeOrigin:.*)#\1// \3\n\1httpSafeOrigin: 'https://${cryptpad_sandbox_url}',#" /var/www/cryptpad/cryptpad/config/config.js
perl -i -n -p -e"s#(\s*)(/*\s*)(httpAddress:.*)#\1// \3\n\1httpAddress: '::',#" /var/www/cryptpad/cryptpad/config/config.js
# - deaktivate donate Button # - deaktivate donate Button
# - # -
perl -i -n -p -e"s#(\s*)(//removeDonateButton:.*)#\1\2\n\1removeDonateButton: true,#" /var/www/cryptpad/config/config.js perl -i -n -p -e"s#(\s*)(/*\s*)(removeDonateButton:.*)#\1//\3\n\1removeDonateButton: true,#" /var/www/cryptpad/cryptpad/config/config.js
# - Set storage.. # - Set storage..
# - # -
perl -i -n -p -e"s#(\s*)(//defaultStorageLimit:.*)#\1\2\n\1defaultStorageLimit: 250 * 1024 * 1024,#" /var/www/cryptpad/config/config.js perl -i -n -p -e"s#(\s*)(/*\s*)(defaultStorageLimit:.*)#\1//\3\n\1defaultStorageLimit: 250 * 1024 * 1024,#" /var/www/cryptpad/cryptpad/config/config.js
# - Customizing CryptPad # - Customizing CryptPad
# - # -
@ -351,26 +460,53 @@ perl -i -n -p -e"s#(\s*)(//defaultStorageLimit:.*)#\1\2\n\1defaultStorageLimit:
# - '/customize.dist/' to '/customize' and then edit it there, this way you will # - '/customize.dist/' to '/customize' and then edit it there, this way you will
# - still be able to pull from (and make pull requests to (!) the git repository. # - still be able to pull from (and make pull requests to (!) the git repository.
# - # -
cp -a /var/www/cryptpad/customize.dist /var/www/cryptpad/customize cp -a /var/www/cryptpad/cryptpad/customize.dist /var/www/cryptpad/cryptpad/customize
# - Copy 'favicon.ico' to '/var/www/cryptpad/customize/main-favicon.png' # - Copy 'favicon.ico' to '/var/www/cryptpad/customize/main-favicon.png'
# - # -
cp ~chris/favicon.ico /var/www/cryptpad/customize/main-favicon.png cp ~chris/favicon.ico /var/www/cryptpad/cryptpad/customize/main-favicon.png
cp ~chris/favicon.ico /var/www/cryptpad/cryptpad/customize.dist
# ---
# Systemd Unit
# ---
# - Run as daemon using systemd # - Run as daemon using systemd
# - # -
cat << EOF > /etc/systemd/system/cryptpad.service cat << EOF > /etc/systemd/system/cryptpad.service
[Unit] [Unit]
Description=CryptPad service Description=CryptPad Service
After=syslog.target network.target
Requires=nginx.service
[Service] [Service]
Type=simple
User=www-data User=www-data
Group=www-data Group=www-data
Environment='PWD="/var/www/cryptpad/cryptpad"'
# modify to match the location of your cryptpad repository
WorkingDirectory=/var/www/cryptpad/cryptpad
ExecStart=/usr/bin/node /var/www/cryptpad/cryptpad/server.js
ExecStart=/usr/bin/node /var/www/cryptpad/server.js TimeoutSec=30
WorkingDirectory=/var/www/cryptpad # Restart service after 10 seconds if node service crashes
RestartSec=2
Restart=always Restart=always
# Output to syslog
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cryptpad
## Modify these two values and uncomment them if you have lots of files and get an HTTP error 500 because of that
LimitMEMLOCK=infinity
LimitNOFILE=65535
### If you want to bind CryptPad to a port below 1024 uncomment the two values below
#CapabilityBoundingSet=CAP_NET_BIND_SERVICE
#AmbientCapabilities=CAP_NET_BIND_SERVICE
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
EOF EOF