I would like to set up ERPNEXT (frappe-framework) as an App on my own ucs.
There is an installation example on Github:
What do I have to change to install it on my UCS 4.4.4?
"Getting Started:
The templates in this repository will help deploy Frappe/ERPNext docker in a production environment.
This docker installation takes care of the following:
Setting up the desired version of Frappe/ERPNext.
Setting up all the system requirements: eg. MariaDB, Node, Redis.
[OPTIONAL] Configuring networking for remote access and setting up LetsEncrypt"
Deployment
Setting up Pre-requisites
This repository requires Docker and Git to be setup on the instance to be used.
Cloning the repository and preliminary steps
Clone this repository somewhere in your system:
git clone https://github.com/frappe/frappe_docker.git
cd frappe_docker
Copy the example docker environment file to .env:
cp installation/env-example installation/.env
Make a directory for sites:
mkdir installation/sites
Setup Environment Variables
To get started, copy the existing env-example file to .env inside the installation directory. By default, the file will contain the following variables:
VERSION=edge
In this case, edge corresponds to develop. To setup any other version, you may use the branch name or version specific tags. (eg. version-12, v11.1.15, v11)
MYSQL_ROOT_PASSWORD=admin
Bootstraps a MariaDB container with this value set as the root password. If a managed MariaDB instance is used, there is no need to set the password here.
MARIADB_HOST=mariadb
Sets the hostname to mariadb. This is required if the database is managed by the containerized MariaDB instance.
In case of a separately managed database setups, set the value to the database's hostname/IP/domain.
SITES=site1.domain.com,site2.domain.com
List of sites that are part of the deployment "bench" Each site is separated by a comma(,).
If LetsEncrypt is being setup, make sure that the DNS for all the site's domains correctly point to the current instance.
LETSENCRYPT_EMAIL=your.email@your.domain.com
Email for LetsEncrypt expiry notification. This is only required if you are setting up LetsEncrypt.
Local deployment for testing
For trying out locally or to develop apps using ERPNext REST API port 80 must be published. The first command will start the containers; the second command will publish the port of the *-nginx container.
For Erpnext:
Start services
docker-compose
–project-name
-f installation/docker-compose-common.yml
-f installation/docker-compose-erpnext.yml
–project-directory installation up -d
Publish port
docker-compose
–project-name
-f installation/docker-compose-common.yml
-f installation/docker-compose-erpnext.yml
–project-directory installation run --publish 80:80 -d erpnext-nginx
For Frappe:
Start services
docker-compose
–project-name
-f installation/docker-compose-common.yml
-f installation/docker-compose-frappe.yml
–project-directory installation up -d
Publish port
docker-compose
–project-name
-f installation/docker-compose-common.yml
-f installation/docker-compose-frappe.yml
–project-directory installation run --publish 80:80 -d frappe-nginx
Make sure to replace with the desired name you wish to set for the project.
Notes:
New site (first site) needs to be added after starting the services.
The local deployment is for testing and REST API development purpose only
A complete development environment is available here
The site names are limited to patterns matching *.localhost by default
Additional site name patterns can be added by editing /etc/hosts of your host machine
Deployment for production
Setup Letsencrypt Nginx Proxy Companion
Letsencrypt Nginx Proxy Companion can optionally be setup to provide SSL. This is recommended for instances accessed over the internet.
Your DNS will need to be configured correctly for Letsencrypt to verify your domain.
To setup the proxy companion, run the following commands:
cd $HOME
git clone https://github.com/evertramos/docker-compose-letsencrypt-nginx-proxy-companion.git
cd docker-compose-letsencrypt-nginx-proxy-companion
cp .env.sample .env
./start.sh
For more details, see the Letsencrypt Nginx Proxy Companion github repo. Letsencrypt Nginx Proxy Companion github repo works by automatically proxying to containers with the VIRTUAL_HOST environmental variable.
Start Frappe/ERPNext Services
To start the Frappe/ERPNext services for production, run the following command:
docker-compose
–project-name
-f installation/docker-compose-common.yml
-f installation/docker-compose-erpnext.yml
-f installation/docker-compose-networks.yml
–project-directory installation up -d
Make sure to replace with any desired name you wish to set for the project.
Notes:
Use docker-compose-frappe.yml in case you need only Frappe without ERPNext.
New site (first site) needs to be added after starting the services.
Docker containers
This repository contains the following docker-compose files, each one containing the described images:
docker-compose-common.yml
redis-cache
volume: redis-cache-vol
redis-queue
volume: redis-queue-vol
redis-socketio
volume: redis-socketio-vol
mariadb: main database
volume: mariadb-vol
docker-compose-erpnext.yml
erpnext-nginx: serves static assets and proxies web request to the appropriate container, allowing to offer all services on the same port.
volume: assets
erpnext-python: main application code
frappe-socketio: enables realtime communication to the user interface through websockets
frappe-worker-default: background runner
frappe-worker-short: background runner for short-running jobs
frappe-worker-long: background runner for long-running jobs
frappe-schedule
docker-compose-frappe.yml
frappe-nginx: serves static assets and proxies web request to the appropriate container, allowing to offer all services on the same port.
volume: assets
erpnext-python: main application code
frappe-socketio: enables realtime communication to the user interface through websockets
frappe-worker-default: background runner
frappe-worker-short: background runner for short-running jobs
frappe-worker-long: background runner for long-running jobs
frappe-schedule
docker-compose-networks.yml: this yaml define the network to communicate with Letsencrypt Nginx Proxy Companion.
Site operations
Setup New Sites
Note:
Wait for the MariaDB service to start before trying to create a new site.
If new site creation fails, retry after the MariaDB container is up and running.
If you're using a managed database instance, make sure that the database is running before setting up a new site.
Use .env file or environment variables instead of passing secrets as command arguments.
Create ERPNext site
docker exec -it
-e “SITE_NAME=$SITE_NAME”
-e “DB_ROOT_USER=$DB_ROOT_USER”
-e “MYSQL_ROOT_PASSWORD=$MYSQL_ROOT_PASSWORD”
-e “ADMIN_PASSWORD=$ADMIN_PASSWORD”
-e “INSTALL_APPS=erpnext”
_erpnext-python_1 docker-entrypoint.sh new
Environment Variables needed:
SITE_NAME: name of the new site to create.
DB_ROOT_USER: MariaDB Root user.
MYSQL_ROOT_PASSWORD: In case of the MariaDB docker container use the one set in MYSQL_ROOT_PASSWORD in previous steps. In case of a managed database use the appropriate password.
MYSQL_ROOT_PASSWORD_FILE - When the MariaDB root password is stored using docker secrets.
ADMIN_PASSWORD: set the administrator password for the new site.
ADMIN_PASSWORD_FILE: set the administrator password for the new site using docker secrets.
INSTALL_APPS=erpnext: available only in erpnext-worker and erpnext containers (or other containers with custom apps). Installs ERPNext (and/or the specified apps, comma-delinieated) on this new site.
FORCE=1: optional variable which force installation of the same site.