cloudron-erpnext: A Shell repository from njsubedi

What

Run erpnext on Cloudron

Why

Because, why not?

Build and Install

Install Cloudron CLI on your machine: npm install -g cloudron-cli.
Install Docker, and make sure you can push to docker hub, or install the docker registry app in your own Cloudron.
Log in to your Cloudron using cloudron cli: cloudron login <my.yourdomain.tld>.
Build and publish the docker image: cloudron build.
If you're using your own docker registry, name the image properly, like docker.example-cloudron.tld/john_doe/cloudron-erpnext.
Log in to Docker Hub and mark the image as public, if necessary.
Install the app cloudron install -l <erp.yourdomain.tld>
Look at the logs to see if everything is going as planned.

Refer to the Cloudron Docs for more information.

About dev-scripts

Please refer to docker-run.sh file for some commands handy for you to test this setup.

Logging in

Look for credentials in the file <your-site-name>-credentials.txt from the file manager.sd

LDAP Connection [WIP]

LDAP Auth is not already configured. When a user logs in for the first time, a new System User is created with ** Guest** role. An admin can then change the user's role.

LDAP Group sync or custom group mapping could also be possible, but I haven't tried it yet. Send a PR if you want.

For now, look at the /app/pkg/setup-ldap.sh and make necessary changes. Run the command to add LDAP settings. The script is configured to use your cloudron's LDAP addon.

/app/pkg/setup-ldap.sh add : adds LDAP settings to the site
/app/pkg/setup-ldap.sh disable: disables LDAP settings (required before deleting)
/app/pkg/setup-ldap.sh delete: deletes the LDAP settings for the site

Installing Apps

You can install new frappe apps. To install the apps, simply follow these steps.

# Make sure you are in the /app/code/frappe-bench directory.
cd /app/code/frappe-bench
gosu cloudron bench get-app <app-name>
gosu cloudron bench install-app <app-name>
gosu cloudron bench restart

# EXAMPLE 1: install the hrms app
gosu cloudron bench get-app hrms
gosu cloudron bench install-app hrms
gosu cloudron bench restart

# EXAMPLE 2: install a specific version of the hrms 
gosu cloudron bench get-app --branch v1.0.0 hrms
gosu cloudron bench install-app hrms
gosu cloudron bench restart

# EXAMPLE 3: install a specific version of the frappedesk 
gosu cloudron bench get-app --branch develop frappedesk
gosu cloudron bench install-app frappedesk
gosu cloudron bench restart

Also refer to the Official Documentation

Updating Apps

Important Notes

MAKE SURE TO TAKE A BACKUP USING CLOUDRON BEFORE TRYING TO UPDATE.
IF THE UPDATE FAILS, THE APP MAY STOP RESPONDING, AND YOU MAY LOSE DATA.

  # Put the app in maintenance mode
  gosu cloudron bench set-maintenance-mode on
  
  # Run the update commands
  
  # Turn off maintenance mode
  gosu cloudron bench set-maintenance-mode off

1. Update with Cloudron CLI

You can update this package normally by pulling the latest version of this repository, then running cloudron build and cloudron update --app your-app-domain. This is the safest way to update the app.

After updating, make sure to run gosu cloudron bench migrate from the terminal while the app is running.

2. Automatic updates with bench

You don't need to update this cloudron package. You can update Frappe, ErpNext and other apps from the cloudron dashboard itself.

  # switch frappe and erpnext app branch to version-14 or any other branch.
  gosu cloudron bench switch-to-branch version-14 frappe erpnext
  
  #if you have more apps, switch to the respective versions for those apps as well
  # gosu cloudron bench switch-to-branch v1.0.0 hrms
  # gosu cloudron bench switch-to-branch develop frappedesk
  # etc...
  
  # update frappe and all apps, then run migration. Note: backups are handled by cloudron (if you have set it up)
  gosu cloudron bench update --reset --no-backup

You can also run each steps one at a time as needed.

  # update apps
  gosu cloudron bench update --pull
  
  # run patches only
  gosu cloudron bench update --patch
  
  # build assets only
  gosu cloudron bench update --build
  
  # update bench (the cli)
  gosu cloudron bench update --bench
  
  # update python packages and node_modules
  gosu cloudron bench update --requirements

Disable public website (eg. Dashboard as homepage)

From the sidebar, Website -> Website Settings -> Landing Page (Home Page) -> Set to app instead of ** home**.

Third-party Intellectual Properties

All third-party product names, company names, and their logos belong to their respective owners, and may be their trademarks or registered trademarks.

njsubedi/cloudron-erpnext