##// END OF EJS Templates
readme updates
ergo -
Show More
@@ -1,4 +1,9 b''
1 Visit:
1 # AppEnlight
2
3 Performance, exception, and uptime monitoring for the Web
2 4
5 ![AppEnlight image](https://raw.githubusercontent.com/AppEnlight/appenlight/gh-pages/static/appenlight.png)
6
7 Visit:
3 8
4 9 [Readme moved to backend directory](backend/README.md)
@@ -1,100 +1,104 b''
1 1 AppEnlight
2 2 -----------
3 3
4 Performance, exception, and uptime monitoring for the Web
5
6 ![AppEnlight image](https://raw.githubusercontent.com/AppEnlight/appenlight/gh-pages/static/appenlight.png)
7
4 8 Automatic Installation
5 9 ======================
6 10
7 11 Use the ansible scripts in the `automation` repository to build complete instance of application
8 12 You can also use `packer` files in `automation/packer` to create whole VM's for KVM and VMWare.
9 13
10 14 Manual Installation
11 15 ===================
12 16
13 17 To run the app you need to have meet prerequsites:
14 18
15 19 - python 3.5+ (currently 3.6 tested)
16 20 - running elasticsearch (6.6.2 tested)
17 21 - running postgresql (9.5+ required, tested 9.6 and 10.6)
18 22 - running redis
19 23
20 24 Install the app by performing
21 25
22 26 pip install -r requirements.txt
23 27
24 28 python setup.py develop
25 29
26 30 Install the appenlight uptime plugin (`ae_uptime_ce` package from `appenlight-uptime-ce` repository).
27 31
28 32 For production usage you can do:
29 33
30 34 pip install appenlight
31 35 pip install ae_uptime_ce
32 36
33 37
34 38 After installing the application you need to perform following steps:
35 39
36 40 1. (optional) generate production.ini (or use a copy of development.ini)
37 41
38 42 appenlight-make-config production.ini
39 43
40 44 2. Setup database structure:
41 45
42 46 appenlight-migratedb -c FILENAME.ini
43 47
44 48 3. To configure elasticsearch:
45 49
46 50 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
47 51
48 52 4. Create base database objects
49 53
50 54 (run this command with help flag to see how to create administrator user)
51 55
52 56 appenlight-initializedb -c FILENAME.ini
53 57
54 58 5. Generate static assets
55 59
56 60 appenlight-static -c FILENAME.ini
57 61
58 62 Running application
59 63 ===================
60 64
61 65 To run the main app:
62 66
63 67 pserve development.ini
64 68
65 69 To run celery workers:
66 70
67 71 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
68 72
69 73 To run celery beat:
70 74
71 75 celery beat -A appenlight.celery --ini FILENAME.ini
72 76
73 77 To run appenlight's uptime plugin:
74 78
75 79 appenlight-uptime-monitor -c FILENAME.ini
76 80
77 81 Real-time Notifications
78 82 =======================
79 83
80 84 You should also run the `channelstream websocket server for real-time notifications
81 85
82 86 channelstream -i filename.ini
83 87
84 88 Testing
85 89 =======
86 90
87 91 To run test suite:
88 92
89 93 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
90 94
91 95
92 96 Development
93 97 ===========
94 98
95 99 To develop appenlight frontend:
96 100
97 101 cd frontend
98 102 npm install
99 103 grunt watch
100 104
General Comments 1
Under Review
author

Auto status change to "Under Review"

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