From 0a9b17f17ba5acfdd4cf10f866ff232c19087a02 2019-03-17 18:53:14 From: Marcin Lulek Date: 2019-03-17 18:53:14 Subject: [PATCH] readme: reorganization --- diff --git a/README.md b/README.md index 0a21481..632919f 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,4 @@ -AppEnlight ------------ +Visit: -Automatic Installation -====================== -Use the ansible scripts in the `automation` repository to build complete instance of application -You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare. - -Manual Installation -=================== - -To run the app you need to have meet prerequsites: - -- python 3.5+ -- running elasticsearch (2.3+/2.4 tested) -- running postgresql (9.5+ required) -- running redis - -Install the app by performing - - pip install -r requirements.txt - - python setup.py develop - -Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository). - -After installing the application you need to perform following steps: - -1. (optional) generate production.ini (or use a copy of development.ini) - - - appenlight-make-config production.ini - -2. Setup database structure: - - - appenlight-migratedb -c FILENAME.ini - -3. To configure elasticsearch: - - - appenlight-reindex-elasticsearch -t all -c FILENAME.ini - -4. Create base database objects - - (run this command with help flag to see how to create administrator user) - - - appenlight-initializedb -c FILENAME.ini - -5. Generate static assets - - - appenlight-static -c FILENAME.ini - -Running application -=================== - -To run the main app: - - pserve development.ini - -To run celery workers: - - celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini - -To run celery beat: - - celery beat -A appenlight.celery --ini FILENAME.ini - -To run appenlight's uptime plugin: - - appenlight-uptime-monitor -c FILENAME.ini - -Real-time Notifications -======================= - -You should also run the `channelstream websocket server for real-time notifications - - channelstream -i filename.ini - -Testing -======= - -To run test suite: - - py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root) - - -Development -=========== - -To develop appenlight frontend: - - cd frontend - npm install - bower install - grunt watch - - -Tagging release -=============== - - bumpversion --current-version 1.1.1 minor --verbose --tag --commit --dry-run +[Readme moved to backend directory](../appenlight/blob/master/backend/README.md) diff --git a/backend/CHANGELOG.md b/backend/CHANGELOG.md new file mode 100644 index 0000000..f3b8f47 --- /dev/null +++ b/backend/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + + + + + + + + + + +## [1.2.0 - 2019-03-17] +### Changed +* Replaced elasticsearch client +* Bumped a most deps to latest version +* Preparing to move from elasticsearch 2.x to modern versions diff --git a/backend/CHANGELOG.rst b/backend/CHANGELOG.rst deleted file mode 100644 index 3d14665..0000000 --- a/backend/CHANGELOG.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. :changelog: - -History -------- - -0.9.1 (2016-XX-XX) -++++++++++++++++++ - -* Added suppot for "NOT' operator in rule engine -* Various bugfixes - - -0.9.0 (2016-06-29) -++++++++++++++++++ - -* first tagged public release diff --git a/backend/README.md b/backend/README.md new file mode 100644 index 0000000..0a21481 --- /dev/null +++ b/backend/README.md @@ -0,0 +1,105 @@ +AppEnlight +----------- + +Automatic Installation +====================== + +Use the ansible scripts in the `automation` repository to build complete instance of application +You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare. + +Manual Installation +=================== + +To run the app you need to have meet prerequsites: + +- python 3.5+ +- running elasticsearch (2.3+/2.4 tested) +- running postgresql (9.5+ required) +- running redis + +Install the app by performing + + pip install -r requirements.txt + + python setup.py develop + +Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository). + +After installing the application you need to perform following steps: + +1. (optional) generate production.ini (or use a copy of development.ini) + + + appenlight-make-config production.ini + +2. Setup database structure: + + + appenlight-migratedb -c FILENAME.ini + +3. To configure elasticsearch: + + + appenlight-reindex-elasticsearch -t all -c FILENAME.ini + +4. Create base database objects + + (run this command with help flag to see how to create administrator user) + + + appenlight-initializedb -c FILENAME.ini + +5. Generate static assets + + + appenlight-static -c FILENAME.ini + +Running application +=================== + +To run the main app: + + pserve development.ini + +To run celery workers: + + celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini + +To run celery beat: + + celery beat -A appenlight.celery --ini FILENAME.ini + +To run appenlight's uptime plugin: + + appenlight-uptime-monitor -c FILENAME.ini + +Real-time Notifications +======================= + +You should also run the `channelstream websocket server for real-time notifications + + channelstream -i filename.ini + +Testing +======= + +To run test suite: + + py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root) + + +Development +=========== + +To develop appenlight frontend: + + cd frontend + npm install + bower install + grunt watch + + +Tagging release +=============== + + bumpversion --current-version 1.1.1 minor --verbose --tag --commit --dry-run diff --git a/backend/README.rst b/backend/README.rst deleted file mode 100644 index 3d14665..0000000 --- a/backend/README.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. :changelog: - -History -------- - -0.9.1 (2016-XX-XX) -++++++++++++++++++ - -* Added suppot for "NOT' operator in rule engine -* Various bugfixes - - -0.9.0 (2016-06-29) -++++++++++++++++++ - -* first tagged public release diff --git a/backend/setup.py b/backend/setup.py index ffcfc3a..7fabc4e 100644 --- a/backend/setup.py +++ b/backend/setup.py @@ -4,8 +4,8 @@ import re from setuptools import setup, find_packages here = os.path.abspath(os.path.dirname(__file__)) -README = open(os.path.join(here, "README.rst")).read() -CHANGES = open(os.path.join(here, "CHANGELOG.rst")).read() +README = open(os.path.join(here, "README.md")).read() +CHANGES = open(os.path.join(here, "CHANGELOG.md")).read() REQUIREMENTS = open(os.path.join(here, "requirements.txt")).readlines()