History

docs: add infra and provisioning docs

Oliver Eyton-Williams committed 5 years ago

Commit 3dca41c1 parent 86cdf861 file · +31 −0Browse files

Unified · Split

docs/maintainers.md+31−0
@@ -88,6 +88,37 @@ If any issue arises, run `heroku rollback` to rollback to the previous version o · 87 unmodified lines
88 88
89If this is your first deploy, make sure another maintainer is around to assist. 89If this is your first deploy, make sure another maintainer is around to assist.
90 90
91## Infrastructure
92
93The bundled documents are available at downloads.devdocs.io and the documents themselves at documents.devdocs.io. Download and document requests are proxied to S3 buckets devdocs-downloads.s3.amazonaws.com and devdocs-documents.s3.amazonaws.com respectively.
94
95If there's ever a need to create a new proxy VM (and the `devdocs-proxy` snapshot is not available) then the new vm should be provisioned as follows:
96
97```bash
98# we need at least nginx 1.19.x
99wget https://nginx.org/keys/nginx_signing.key
100apt-key add nginx_signing.key
101echo 'deb https://nginx.org/packages/mainline/ubuntu/ focal nginx' >> /etc/apt/sources.list
102echo 'deb-src https://nginx.org/packages/mainline/ubuntu/ focal nginx' >> /etc/apt/sources.list
103apt-get -y remove nginx-common
104apt-get -y update
105apt-get -y install nginx
106
107# the config is on github
108rm -rf /etc/nginx/*
109rm -rf /etc/nginx/.* 2> /dev/null
110git clone https://github.com/freeCodeCamp/devdocs-nginx-config.git /etc/nginx
111
112# at this point we need to add the certs from Cloudflare and test the config
113nginx -t
114
115# if nginx is already running, just
116# ps aux | grep nginx
117# find the number and kill it
118
119nginx
120```
121
91## List of maintainers in alphabetical order122## List of maintainers in alphabetical order
92 123
93The following people (used to) maintain DevDocs:124The following people (used to) maintain DevDocs: