Overview

This is a deployment setup manualy to contain WIKI2 and VSCode for using as personal note.

Solves the following issues for WIKI2.

• Using the nginx proxy server to limit unnecessary external exposure of application services under.
• Complementing not yet implemented features, improving the security. example, out of control to request unwanted external hosts in PlantUML.

Added The VSCode Cloud Service of gitpod-io. VSCode uses WIKI2's JWT/JWK as authentication, enabling access control from a private server safely.

Sorry, but I have no intention of considering automating the deployment. You may need backend development knowledge.

Settings

Local

Try running this deployment version simply locally.

$ mkdir ./local-test/backup
$ mkdir ./local-test/logs
$ mkdir ./local-test/pgdata

$ cd ./local-test
$ docker-compose up -d

$ docker-compose logs -f

Production

In all files, refer to the volumes list entry below, define it for your environment and rewrite all paths in ${..}.

/docker-compose.yml
/nginx.conf

If you have modified all ${..} in the above files, distribute it through the command below.

$ openssl rand -base64 32 > ${file.db.secret}
$ docker-compose up -d

volumes

Usage	Volume	Hostname	Type	Binding
nginx pub	${dir.nginx.public}	web	dir	/var/www/public
nginx log	${dir.nginx.log}	web	dir	/usr/local/nginx/log
nginx conf	${file.nginx.conf}	web	file(ro)	/etc/nginx/nginx.conf
nginx cert	${dir.certbot.main}	web	dir	/etc/nginx/ssl
nginx certbot dir	${dir.certbot.public}	web	dir	/var/www/certbot
nginx crontab list	${file.crontab.list}	web	file(ro)	/etc/cron.d/root:ro
logrotate conf	${file.logrotate.nginx}	web	file(ro	/etc/logrotate.d/nginx
certbot conf	${dir.certbot.main}	certbot	dir	/etc/letsencrypt
certbot log	${dir.certbot.logs}	certbot	dir	/var/log/letsencrypt
certbot public dir	${dir.certbot.public}	cerbot	dir	/var/www/certbot
db secert	${file.db.secret}	db	file(ro)	/etc/wiki/.db-secret
db data	${dir.db.data}	db	dir	/var/lib/postgresql/data
wiki db secret	${file.db.secret}	wiki	file(ro)	/etc/wiki/.db-secret
wiki github secret	${file.storage.github.pem}	wiki	file(ro)	/etc/wiki/github.pem
wiki db backup	${dir.storage.backup}	wiki	dir	/etc/wiki/backup
update companion	/var/run/docker.sock	wiki-update-companion	file(ro)	/var/run/docker.sock

App configurations

It is set in the admin page of wiki.2.

1. Stroage > Local File System (/a/storage)
   • path: /etc/wiki/backup
2. Storage > Git (/a/storage)
   • SSH Private Key Path: /etc/wiki/github.pem
3. Rendering > Kroki (/a/rendering)
   • Kroki Server: http://kroki:8000
4. Rendering > PlantUML (/a/rendering)
   • PlantUML Server: https://${your.domain.com}/plantuml
5. favicon
   • Create a favicon at https://realfavicongenerator.net
   • Location the files to ${dir.nginx.public}/favicon_package

Management

Version update

First, go to your docker-compose.yml file location.

# Get the latest image
$ docker-compose pull

# Replace only the container using the old version image
$ docker-compose up --detach

# Remove all unnecessary images
$ docker image prune -f

TLS update

Certificate renewal.

docker run -it --rm --name certbot -v '${dir.certbot.main}:/etc/letsencrypt' -v '${dir.certbot.logs}:/var/log/letsencrypt' -v '${dir.certbot.public}:/var/www/certbot' certbot/certbot renew --server https://acme-v02.api.letsencrypt.org/directory --cert-name ${your.domain.com}

(Refer to the volumes list )

Check remaining certificate expiration date.

docker run -it --rm --name certbot -v '${dir.certbot.main}:/etc/letsencrypt' -v '${dir.certbot.logs}:/var/log/letsencrypt' -v '${dir.certbot.public}:/var/www/certbot' certbot/certbot certificates