https://github.com/monogramm/erpnext_autoinstall

:snake: :alembic: ERPNext Frappe application to automatically setup ERPNext on install.
https://github.com/monogramm/erpnext_autoinstall

erpnext frappe python

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/monogramm/erpnext_autoinstall
• Owner: Monogramm
• License: agpl-3.0
• Created: 2019-08-21T12:56:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-10T04:47:24.000Z (11 months ago)
• Last Synced: 2025-03-27T20:11:16.630Z (7 months ago)
• Topics: erpnext, frappe, python
• Language: Python
• Homepage:
• Size: 661 KB
• Stars: 25
• Watchers: 5
• Forks: 15
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![License: AGPL v3][uri_license_image]][uri_license]

[![gitmoji-changelog](https://img.shields.io/badge/Changelog-gitmoji-blue.svg)](https://github.com/frinyvonnick/gitmoji-changelog)

[![Managed with Taiga.io](https://img.shields.io/badge/managed%20with-TAIGA.io-709f14.svg)](https://tree.taiga.io/project/monogrammbot-monogrammerpnext_autoinstall/ "Managed with Taiga.io")

[![Build Status](https://travis-ci.org/Monogramm/erpnext_autoinstall.svg)](https://travis-ci.org/Monogramm/erpnext_autoinstall)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c50508ec09f644f590c11e0e50e10a96)](https://www.codacy.com/gh/Monogramm/erpnext_autoinstall?utm_source=github.com&utm_medium=referral&utm_content=Monogramm/erpnext_autoinstall&utm_campaign=Badge_Grade)

[![codecov](https://codecov.io/gh/Monogramm/erpnext_autoinstall/branch/master/graph/badge.svg)](https://codecov.io/gh/Monogramm/erpnext_autoinstall)

[![Coverage Status](https://coveralls.io/repos/github/Monogramm/erpnext_autoinstall/badge.svg?branch=master)](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