erpnext_autoinstall icon indicating copy to clipboard operation
erpnext_autoinstall copied to clipboard

:snake: :alembic: ERPNext Frappe application to automatically setup ERPNext on install.

License: AGPL v3 gitmoji-changelog Managed with Taiga.io Build Status Codacy Badge codecov Coverage Status

ERPNext AutoInstall

:alembic: Experimental Frappe application for automatic setup of ERPNext.

The objective is to setup ERPNext automatically based on environment variables, mainly for docker usage.

https://discuss.erpnext.com/t/setup-ldap-through-command-line/49735

:chart_with_upwards_trend: Changes

All notable changes to this project will be documented in CHANGELOG file.

This CHANGELOG is generated with :heart: by gitmoji-changelog This project adheres to Semantic Versioning.

:bookmark: Roadmap

See Taiga.io

:construction: Install

bench get-app --branch master erpnext_autoinstall https://github.com/Monogramm/erpnext_autoinstall

:rocket: Usage

bench install-app erpnext_autoinstall

Environment variables for automatic setup:

  • WebSite configuration

    • DISABLE_SIGNUP
    • HOME_PAGE
  • LDAP configuration

    • LDAP_ENABLED
    • LDAP_SERVER_URL
    • LDAP_BASE_DN
    • LDAP_PASSWORD
    • LDAP_USERS_ORGANIZATIONAL_UNIT
    • LDAP_DEFAULT_ROLE
    • LDAP_SEARCH_STRING
    • LDAP_EMAIL_FIELD
    • LDAP_USERNAME_FIELD
    • LDAP_FIRST_NAME_FIELD
    • LDAP_MIDDLE_NAME_FIELD
    • LDAP_LAST_NAME_FIELD
    • LDAP_PHONE_FIELD
    • LDAP_MOBILE_FIELD
    • LDAP_SSL_TLS_MODE

Environment variables not ready yet:

  • Email domain configuration

    • EMAIL_DOMAIN_SERVER
    • EMAIL_DOMAIN_ID
    • EMAIL_DOMAIN_NAME
    • EMAIL_DOMAIN_SMTP_SERVER
    • EMAIL_DOMAIN_PORT
    • EMAIL_DOMAIN_USE_IMAP
    • EMAIL_DOMAIN_USE_SSL
    • EMAIL_DOMAIN_USE_TLS
    • EMAIL_DOMAIN_ATTACHMENT_LIMIT_MB
  • Email accounts configuration

    • EMAIL_ACCOUNT_ADDRESS_ACCOUNT
    • EMAIL_ACCOUNT_PASSWORD

Custom bench commands:

  • bench list-users: Show list of users
  • bench add-user: Create new user
  • bench delete-user: Delete user from database
  • bench set-user-password: Update user password
  • bench set-user-roles: Set roles for user
  • bench set-user-role-profile: Set role profile for user
  • bench add-user-api-key: Generate API key by username (doesn't work in version 10)
  • bench get-user-api-key: Get API key by username (doesn't work in version 10)
  • bench get-user-api-secret: Get API secret by username (doesn't work in version 10)

:white_check_mark: Run tests

bench bench run-tests --profile --app erpnext_autoinstall

:bust_in_silhouette: Authors

Monogramm

Аминов Эмиль

:handshake: Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. Check the contributing guide.

:thumbsup: Show your support

Give a :star: if this project helped you!

:page_facing_up: License

Copyright © 2019 Monogramm.
This project is AGPL v3 licensed.


This README was generated with :heart: by readme-md-generator