Skip to content

Commit

Permalink
readme: provide better descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
ergo committed Apr 13, 2019
1 parent 6ba6bd9 commit 78228cf
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ Performance, exception, and uptime monitoring for the Web
Automatic Installation
======================

Use the ansible scripts in the `automation` repository to build complete instance of application
Use the ansible or vagrant 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.

https://github.com/AppEnlight/automation

Manual Installation
===================

Expand Down Expand Up @@ -41,7 +43,7 @@ After installing the application you need to perform following steps:

appenlight-make-config production.ini

2. Setup database structure:
2. Setup database structure (replace filename with the name you picked for `appenlight-make-config`):

appenlight-migratedb -c FILENAME.ini

Expand All @@ -64,7 +66,7 @@ Running application

To run the main app:

pserve development.ini
pserve FILENAME.ini

To run celery workers:

Expand All @@ -74,16 +76,17 @@ To run celery beat:

celery beat -A appenlight.celery --ini FILENAME.ini

To run appenlight's uptime plugin:
To run appenlight's uptime plugin (example of uptime plugin config can be found here
https://github.com/AppEnlight/appenlight-uptime-ce ):

appenlight-uptime-monitor -c FILENAME.ini
appenlight-uptime-monitor -c UPTIME_PLUGIN_CONFIG_FILENAME.ini

Real-time Notifications
=======================

You should also run the `channelstream websocket server for real-time notifications

channelstream -i filename.ini
channelstream -i CHANELSTRAM_CONFIG_FILENAME.ini

Additional documentation
========================
Expand Down

0 comments on commit 78228cf

Please sign in to comment.