[Guide] How to install ERPNext v15 on Linux Ubuntu (step-by-step instructions)

ERPNext
, ,
64

python 3.10?
for ERPNext v15 you need 3.11+ as far as I know

65

This is a bench playbook error caused by a recent ansible update.

Go to this file:

/usr/local/lib/python${python_version}/dist-packages/bench/playbooks/roles/mariadb/tasks/main.yml

Change include to include_tasks and re-run sudo bench setup production $USER and your installation should be completed.

You can also use the script i shared above for installation.

3 Likes
66

I could run the install script yesterday but with many errors.

67

@flexy2ky , I raised an issue ticket on github, as it seems that there are others have the same issue, fyki, i also purchased a vps on contabo and tried your script and it suddenly closes the putty/bitvise terminal screen.
thanks for your support

68

Thanks for flagging the issue. Please refer to my response on GitHub. Thanks

1 Like
69

Getting Error on step 5. Please Help

sudo pip3 install frappe-bench
error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.

If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.

If you wish to install a non-Debian packaged Python application,
it may be easiest to use pipx install xyz, which will manage a
virtual environment for you. Make sure you have pipx installed.

See /usr/share/doc/python3.11/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

70

To disable the externally-managed-environment error

sudo python3 -m pip config --global set global.break-system-packages true
1 Like
71

Got an error at bench init frappe-bench --version $bench_version --verbose:

Traceback (most recent call last):
  File "/usr/local/bin/bench", line 8, in <module>
    sys.exit(cli())
  File "/usr/local/lib/python3.10/dist-packages/bench/cli.py", line 74, in cli
    cmd_from_sys = get_cmd_from_sysargv()
  File "/usr/local/lib/python3.10/dist-packages/bench/utils/__init__.py", line 581, in get_cmd_from_sysargv
    if sys_argv.index(arg) == 0 and arg in Bench(".").apps:
  File "/usr/local/lib/python3.10/dist-packages/bench/bench.py", line 67, in __init__
    self.apps = BenchApps(self)
  File "/usr/local/lib/python3.10/dist-packages/bench/bench.py", line 175, in __init__
    self.initialize_apps()
  File "/usr/local/lib/python3.10/dist-packages/bench/bench.py", line 282, in initialize_apps
    self.apps.remove("frappe")
ValueError: list.remove(x): x not in list
An error occurred on line 351 with exit status 0

Trying to reinstall the system.

72

I think this happened because I updated the Ubuntu 22.04.4 installer during installation.
Tried three times, eventually without updating the installer.
Problem solved(?)

1 Like
73

sudo bench setup production [frappe-user] might not work if you don’t do the following!!

error (deprecated): ansible.builtin.include has been removed

Solution

  1. sudo nano /usr/local/lib/python3.1/dist-packages/bench/playbooks/roles/mariadb/tasks/main.yml

  2. copy the following code below (updated-ansible-main-file/main.yaml at main · karani-gk/updated-ansible-main-file · GitHub)

image
image1280×1024 94.9 KB

  • include_tasks: centos.yml
    when: ansible_distribution == ‘CentOS’ and ansible_distribution_major_version|int >= 6

  • include_tasks: ubuntu-trusty.yml
    when: ansible_distribution == ‘Ubuntu’ and ansible_distribution_version == ‘14.04’

  • include_tasks: ubuntu-xenial_bionic.yml
    when: ansible_distribution == ‘Ubuntu’ and ansible_distribution_major_version|int >= 16

  • name: Add configuration
    template:
    src: ‘{{ mysql_conf_tpl }}’
    dest: ‘{{ mysql_conf_dir[ansible_distribution] }}/{{ mysql_conf_file }}’
    owner: root
    group: root
    mode: 0644
    when: mysql_conf_tpl != ‘change_me’ and ansible_distribution != ‘Debian’
    notify: restart mariadb

  • include_tasks: debian.yml
    when: ansible_distribution == ‘Debian’

  • name: Add configuration
    template:
    src: ‘{{ mysql_conf_tpl }}’
    dest: ‘{{ mysql_conf_dir[ansible_distribution] }}/{{ mysql_conf_file }}’
    owner: root
    group: root
    mode: 0644
    when: mysql_conf_tpl != ‘change_me’ and ansible_distribution == ‘Debian’
    notify: restart mariadb

  • name: Add additional conf for MariaDB 10.2 in mariadb.conf.d
    blockinfile:
    path: /etc/mysql/conf.d/settings.cnf
    block: |
    # Import all .cnf files from configuration directory
    !includedir /etc/mysql/mariadb.conf.d/
    become: yes
    become_user: root
    when: ansible_distribution == ‘Ubuntu’ or ansible_distribution == ‘Debian’

  • name: Add additional conf for MariaDB 10.2 in mariadb.conf.d
    blockinfile:
    path: /etc/mysql/mariadb.conf.d/erpnext.cnf
    block: |
    [mysqld]
    pid-file = /var/run/mysqld/mysqld.pid
    socket = /var/run/mysqld/mysqld.sock

    # setting appeared inside mysql but overwritten by mariadb inside mariadb.conf.d/xx-server.cnf valued as utf8mb4_general_ci

collation-server = utf8mb4_unicode_ci

    create: yes
    become: yes
    become_user: root
    when: ansible_distribution == ‘Ubuntu’ or ansible_distribution == ‘Debian’

  • name: Start and enable service
    service:
    name: mariadb
    state: started
    enabled: yes

  • debug:
    msg: “{{ mysql_root_password }}”

  • include_tasks: mysql_secure_installation.yml
    when: mysql_root_password is defined

  • debug:
    var: mysql_secure_installation
    when: mysql_secure_installation and mysql_root_password is defined

…

  1. Paste into main.yml file located at /usr/local/lib/python3.1/dist-packages/bench/playbooks/roles/mariadb/tasks/

  2. Now you can run sudo bench setup production [frappe-user] successfully without errors.

2 Likes
74

nice guideline, I appreciate this

75

Thanks - I installed frappe ‘as’ the same user I was running it with - it’s a dev server, but you STILL have to execute this step.

      == John ==
76

This needs to be documented (or fixed!)

1 Like
77

Appreciate it!

78

Here’s one for you:
Why do we need xvfb?
It has a s##t load of dependancies.
What does it do? Do we actually use an X server at all?

79

Thank you for this. Was able to install without any sort of errors. With other guides i always stumble upon an error and it eats up hours.

Only problem was with HRMS.

80

try installing HRMS after setting production env.

81

List the files and directories within the ‘assets’ folder with detailed information (permissions, owner, size, etc.)

ls -l /home/[user]/frappe-bench/sites/assets

Change to the ‘assets’ directory, where the public files of the apps are located

cd /home/[user]/frappe-bench/sites/assets

Remove existing symbolic links if they are incorrect or need to be updated.

Make sure to check if these apps are installed before removing them. These lines may vary depending on your installation.

rm frappe erpnext # Remove symbolic links for Frappe and ERPNext (commonly installed)
rm lms hrms # Optional: Only remove if you have LMS or HRMS apps installed

Create new symbolic links pointing to the correct public directories of the installed apps.

Adjust the paths according to your app locations.

ln -s …/…/apps/frappe/frappe/public frappe # Symbolic link for Frappe (required if using Frappe)
ln -s …/…/apps/erpnext/erpnext/public erpnext # Symbolic link for ERPNext (required if using ERPNext)

Optional: Only create these links if you have LMS or HRMS installed

ln -s …/…/apps/lms/lms/public lms # Symbolic link for LMS (optional, only if using LMS)
ln -s …/…/apps/hrms/hrms/public hrms # Symbolic link for HRMS (optional, only if using HRMS)

Recursively change the owner and group of all files inside frappe-bench.

Replace [user] with your actual username.

sudo chown -R [user]:[user] /home/[user]/frappe-bench

Set read and execute permissions for all directories under ‘sites’. Permissions 755 (read and execute for all, write only for the owner)

sudo find /home/[user]/frappe-bench/sites -type d -exec chmod 755 {} ;

Set read permissions for all files under ‘sites’. Permissions 644 (read for all, write only for the owner)

sudo find /home/[user]/frappe-bench/sites -type f -exec chmod 644 {} ;

Add the web server user (e.g., ‘www-data’ for Nginx/Apache) to the current user’s group

Replace [user] with your actual username.

sudo usermod -a -G [user] www-data

Reload Nginx to apply the changes without restarting the service completely

sudo service nginx reload