Erpnext Autoinstall
:snake: :alembic: ERPNext Frappe application to automatically setup ERPNext on install.
- Author: Monogramm
- Repository: https://github.com/Monogramm/erpnext_autoinstall
- GitHub stars: 26
- Forks: 16
- License: AGPL-3.0
- Category: Developer Tools
- Maintenance: Minimally Maintained
- Frappe versions: develop
Install Erpnext Autoinstall
bench get-app https://github.com/Monogramm/erpnext_autoinstall
Tags
- erpnext
- frappe
Add the Frappe Gems badge to your README
Maintain Erpnext Autoinstall? Paste this into your README:
[](https://frappegems.com/gems/apps/Monogramm/erpnext_autoinstall)
About Erpnext Autoinstall
[![License: AGPL v3][uri_license_image]][uri_license]
[](https://github.com/frinyvonnick/gitmoji-changelog)
[](https://tree.taiga.io/project/monogrammbot-monogrammerpnext_autoinstall/ "Managed with Taiga.io")
[](https://travis-ci.org/Monogramm/erpnext_autoinstall)
[](https://www.codacy.com/gh/Monogramm/erpnext_autoinstall?utm_source=github.com&utm_medium=referral&utm_content=Monogramm/erpnext_autoinstall&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/Monogramm/erpnext_autoinstall)
[](https://coveralls.io/github/Monogramm/erpnext_autoinstall?branch=master)
# 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.
## :chart_with_upwards_trend: Changes
All notable changes to this project will be documented in [CHANGELOG](./CHANGELOG.md) file.
This CHANGELOG is generated with :heart: by [gitmoji-changelog](https://github.com/frinyvonnick/gitmoji-changelog)
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## :bookmark: Roadmap
See [Taiga.io](https://tree.taiga.io/project/monogrammbot-monogrammerpnext_autoinstall/ "Taiga.io monogrammbot-monogrammerpnext_autoinstall")
## :construction: Install
```sh
bench get-app --branch master erpnext_autoinstall https://github.com/Monogramm/erpnext_autoinstall
```
## :rocket: Usage
```sh
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
```sh
bench bench run-tests --profile --app erpnext_autoinstall
```
## :bust_in_silhouette: Authors
**Monogramm**
- Website:
- Github: [@Monogramm](https://github.com/Monogramm)
**Аминов Эмиль**
- Website:
- Github: [@AminovE99](https://github.com/AminovE99)
## :handshake: Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Monogramm/erpnext_autoinstall/issues). [Check the contributing guide](./CONTRIBUTING.md).
## :thumbsup: Show your support Give a :star: if this project helped you! ## :page_facing_up: License Copyright © 2019 [Monogramm](https://github.com/Monogramm).
This project is [AGPL v3](uri_license) licensed. * * * _This README was generated with :heart: by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ [uri_license]: http://www.gnu.org/licenses/agpl.html [uri_license_image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
Feel free to check [issues page](https://github.com/Monogramm/erpnext_autoinstall/issues). [Check the contributing guide](./CONTRIBUTING.md).
## :thumbsup: Show your support Give a :star: if this project helped you! ## :page_facing_up: License Copyright © 2019 [Monogramm](https://github.com/Monogramm).
This project is [AGPL v3](uri_license) licensed. * * * _This README was generated with :heart: by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ [uri_license]: http://www.gnu.org/licenses/agpl.html [uri_license_image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
Related Developer Tools apps for Frappe & ERPNext
- Frappe — Low code web framework for real world applications, in Python and Javascript
- Frappe Docker — Docker environment for developing, deploying, and running Frappe applications (ERPNext and custom apps) in production and development
- Builder — Craft beautiful websites effortlessly with an intuitive visual builder and publish them instantly
- Bench — CLI to manage Multi-tenant deployments for Frappe apps
- Frappe Ui — A set of components and utilities for rapid UI development
- Press — Full service cloud hosting for the Frappe stack - powers Frappe Cloud
- Gameplan — Open Source Discussions Platform for Remote Teams
- Doppio — A Frappe app (CLI) to magically setup single page applications and Vue/React powered desk pages on your custom Frappe apps.