From 9450a3d621cad3fea2219a7ecdf1d5f38cab106f Mon Sep 17 00:00:00 2001 From: Lev Vereshchagin Date: Fri, 17 Dec 2021 15:09:44 +0300 Subject: [PATCH] Remove extra docs --- docs/environment-variables.md | 33 ----------------------------- docs/tips-for-moving-deployments.md | 15 ------------- 2 files changed, 48 deletions(-) delete mode 100644 docs/environment-variables.md delete mode 100644 docs/tips-for-moving-deployments.md diff --git a/docs/environment-variables.md b/docs/environment-variables.md deleted file mode 100644 index b5ebb89d..00000000 --- a/docs/environment-variables.md +++ /dev/null @@ -1,33 +0,0 @@ -List of environment variables for containers - -### frappe-worker and erpnext-worker - -Following environment variables are set into sites volume as `common_site_config.json`. It means once the file is created in volume, the variables won't have any effect, you need to edit the common_site_config.json to update the configuration - -- `DB_HOST`: MariaDB host, domain name or ip address. -- `DB_PORT`: MariaDB port. -- `REDIS_CACHE`: Redis cache host, domain name or ip address. -- `REDIS_QUEUE`: Redis queue host, domain name or ip address. -- `REDIS_SOCKETIO`: Redis queue host, domain name or ip address. -- `SOCKETIO_PORT: `: Port on which the SocketIO should start. -- `WORKER_CLASS`: Optionally set gunicorn worker-class. Supports gevent only, defaults to gthread. - -### frappe-nginx and erpnext-nginx - -These variables are set on every container start. Change in these variables will reflect on every container start. - -- `FRAPPE_PY`: Gunicorn host to reverse proxy. Default: 0.0.0.0 -- `FRAPPE_PY_PORT`: Gunicorn port to reverse proxy. Default: 8000 -- `FRAPPE_SOCKETIO`: SocketIO host to reverse proxy. Default: 0.0.0.0 -- `SOCKETIO_PORT`: SocketIO port to reverse proxy. Default: 9000 -- `HTTP_TIMEOUT`: Nginx http timeout. Default: 120 -- `UPSTREAM_REAL_IP_ADDRESS `: The trusted address (or ip range) of upstream proxy servers. If set, this will tell nginx to trust the X-Forwarded-For header from these proxy servers in determining the real IP address of connecting clients. Default: 127.0.0.1 -- `UPSTREAM_REAL_IP_RECURSIVE`: When set to `on`, this will tell nginx to not just look to the last upstream proxy server in determining the real IP address. Default: off -- `UPSTREAM_REAL_IP_HEADER`: Set this to the header name sent by your upstream proxy server to indicate the real IP of connecting clients. Default: X-Forwarded-For -- `FRAPPE_SITE_NAME_HEADER`: NGINX `X-Frappe-Site-Name` header in the HTTP request which matches a site name. Default: `$host` -- `HTTP_HOST`: NGINX `Host` header in the HTTP request which matches a site name. Default: `$http_host` -- `SKIP_NGINX_TEMPLATE_GENERATION`: When set to `1`, this will not generate a default NGINX configuration. The config file must be mounted inside the container (`/etc/nginx/conf.d`) by the user in this case. Default: `0` - -### frappe-socketio - -This container takes configuration from `common_site_config.json` which is already created by erpnext gunicorn container. It doesn't use any environment variables. diff --git a/docs/tips-for-moving-deployments.md b/docs/tips-for-moving-deployments.md deleted file mode 100644 index 8687c5a4..00000000 --- a/docs/tips-for-moving-deployments.md +++ /dev/null @@ -1,15 +0,0 @@ -# Tips for moving deployments - -- Take regular automatic backups and push the files to S3 compatible cloud. Setup backup and push with cronjobs - - Use regular cron for single machine installs - - Use [swarm-cronjob](https://github.com/crazy-max/swarm-cronjob) for docker swarm - - Use Kubernetes CronJob -- It makes it easy to transfer data from cloud to any new deployment. -- They are just [site operations](site-operations.md) that can be manually pipelined as per need. -- Remember to restore encryption keys and other custom configuration from `site_config.json`. -- Steps to move deployment: - - [Take backup](site-operations.md#backup-sites) - - [Push backup to cloud](site-operations.md#push-backup-to-s3-compatible-storage) - - Create new deployment type anywhere - - [Restore backup from cloud](site-operations.md#restore-backups) - - [Restore `site_config.json` from cloud](site-operations.md#edit-configs)