##// END OF EJS Templates
readme: provide better descriptions
ergo -
Show More
@@ -1,109 +1,112 b''
1 1 AppEnlight
2 2 -----------
3 3
4 4 Performance, exception, and uptime monitoring for the Web
5 5
6 6 ![AppEnlight image](https://raw.githubusercontent.com/AppEnlight/appenlight/gh-pages/static/appenlight.png)
7 7
8 8 Automatic Installation
9 9 ======================
10 10
11 Use the ansible scripts in the `automation` repository to build complete instance of application
11 Use the ansible or vagrant scripts in the `automation` repository to build complete instance of application.
note

dddd

12 12 You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare.
13 13
14 https://github.com/AppEnlight/automation
15
14 16 Manual Installation
15 17 ===================
16 18
17 19 To run the app you need to have meet prerequsites:
18 20
19 21 - python 3.5+ (currently 3.6 tested)
20 22 - running elasticsearch (6.6.2 tested)
21 23 - running postgresql (9.5+ required, tested 9.6 and 10.6)
22 24 - running redis
23 25
24 26 Install the app by performing
25 27
26 28 pip install -r requirements.txt
27 29
28 30 python setup.py develop
29 31
30 32 Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
31 33
32 34 For production usage you can do:
33 35
34 36 pip install appenlight
35 37 pip install ae_uptime_ce
36 38
37 39
38 40 After installing the application you need to perform following steps:
39 41
40 42 1. (optional) generate production.ini (or use a copy of development.ini)
41 43
42 44 appenlight-make-config production.ini
43 45
44 2. Setup database structure:
46 2. Setup database structure (replace filename with the name you picked for `appenlight-make-config`):
45 47
46 48 appenlight-migratedb -c FILENAME.ini
47 49
48 50 3. To configure elasticsearch:
49 51
50 52 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
51 53
52 54 4. Create base database objects
53 55
54 56 (run this command with help flag to see how to create administrator user)
55 57
56 58 appenlight-initializedb -c FILENAME.ini
57 59
58 60 5. Generate static assets
59 61
60 62 appenlight-static -c FILENAME.ini
61 63
62 64 Running application
63 65 ===================
64 66
65 67 To run the main app:
66 68
67 pserve development.ini
69 pserve FILENAME.ini
68 70
69 71 To run celery workers:
70 72
71 73 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
72 74
73 75 To run celery beat:
74 76
75 77 celery beat -A appenlight.celery --ini FILENAME.ini
76 78
77 To run appenlight's uptime plugin:
79 To run appenlight's uptime plugin (example of uptime plugin config can be found here
80 https://github.com/AppEnlight/appenlight-uptime-ce ):
78 81
79 appenlight-uptime-monitor -c FILENAME.ini
82 appenlight-uptime-monitor -c UPTIME_PLUGIN_CONFIG_FILENAME.ini
80 83
81 84 Real-time Notifications
82 85 =======================
83 86
84 87 You should also run the `channelstream websocket server for real-time notifications
85 88
86 channelstream -i filename.ini
89 channelstream -i CHANELSTRAM_CONFIG_FILENAME.ini
87 90
88 91 Additional documentation
89 92 ========================
90 93
91 94 Visit https://getappenlight.com for additional server and client documentation.
92 95
93 96 Testing
94 97 =======
95 98
96 99 To run test suite:
97 100
98 101 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
99 102
100 103
101 104 Development
102 105 ===========
103 106
104 107 To develop appenlight frontend:
105 108
106 109 cd frontend
107 110 npm install
108 111 grunt watch
109 112
General Comments 2
Approved

test

Under Review
author

Auto status change to "Under Review"

You need to be logged in to leave comments. Login now