You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Sarah Jamie Lewis 06eb758b7b
New Blog
1 month ago
blog New Blog 1 month ago
build-staging New Blog 1 month ago
developing Fixup rust example 5 months ago
docs Whonix doc 2 months ago
i18n New Blog 1 month ago
security Erinn Comments 7 months ago
src Roadmap update draft, translate homepage features 3 months ago
static New Nightly 2 months ago
.gitignore Cache build staging due to memory usage build issues on docs. 3 months ago
.yarnrc.yml Update Docusaurus 4 months ago Update Readme 4 months ago
babel.config.js theme image 1 year ago
crowdin.yml Enable blog and developing translations 2 months ago
docusaurus.config.js Update Edit Link 4 months ago
package-lock.json Update translations 4 months ago
package.json Update translations 4 months ago
sidebars.js test stub 1 year ago

Cwtch Website

This website is built using Docusaurus 2, a modern static website generator.


$ yarn


install NVM to manage multiple and new NodeJS versions, and then install NodeJS 16

$ nvm install 16
$ nvm use 16

nvm only works in bash shell

Local Development

$ yarn start


$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.


$ yarn build


$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment to Stable

Using to manage but deployment by push is to a separate docs server. Add your key to the docusaurus account's .ssh/authorized_keys and then

$ git remote add docs
$ git push docs staging

Deployment to Prod

The staging website must be manually promoted to prod. This can be done by logging into the docs server as docusarus and running:

rsync -a --delete staging/ prod/