##// END OF EJS Templates
readme: updated readme
ergo -
Show More
@@ -10,56 +10,88 b" You can also use `packer` files in `/automation/packer` to create whole VM's for"
10 Manual Installation
10 Manual Installation
11 ===================
11 ===================
12
12
13 To run the app you need to have meet prerequsites:
14
15 - python 3.5+
16 - running elasticsearch (2.3+ tested)
17 - running postgresql (9.5+ required)
18 - running redis
19
13 Install the app by performing
20 Install the app by performing
14
21
15 pip install -r requirements.txt
22 pip install -r requirements.txt
16
23
17 python setup.py develop
24 python setup.py develop
18
25
19 To run the app and configure datastore you need to run:
26 Install the appenlight uptime plugin (`ae_uptime_ce` package).
20
21 * python 3.5+
22 * elasticsearch (2.2+ tested)
23 * postgresql 9.5+
24 * redis 2.8+
25
27
26 after installing the application you need to:
28 After installing the application you need to perform following steps:
27
29
28 1. (optional) generate production.ini (or use a copy of development.ini)
30 1. (optional) generate production.ini (or use a copy of development.ini)
29
31
32
30 appenlight-make-config production.ini
33 appenlight-make-config production.ini
31
34
32 2. setup database structure:
35 2. Setup database structure:
36
33
37
34 appenlight-migrate-db -c FILENAME.ini
38 appenlight-migrate-db -c FILENAME.ini
35
39
36 3. to configure elasticsearch:
40 3. To configure elasticsearch:
37
41
38 appenlight-reindex-elasticsearch -c FILENAME.ini
39
42
40 4. create base database objects
43 appenlight-reindex-elasticsearch -t all -c FILENAME.ini
44
45 4. Create base database objects
46
41
47
42 appenlight-initializedb -c FILENAME.ini
48 appenlight-initializedb -c FILENAME.ini
43
49
44 5. generate static assets
50 5. Generate static assets
51
45
52
46 appenlight-static -c FILENAME.ini
53 appenlight-static -c FILENAME.ini
47
54
48 Running application
55 Running application
49 ===================
56 ===================
50
57
51 to run the main app:
58 To run the main app:
52
59
53 pserve development.ini
60 pserve development.ini
54
61
55 to run celery workers:
62 To run celery workers:
56
63
57 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
64 celery worker -A appenlight.celery -Q "reports,logs,metrics,default" --ini FILENAME.ini
58
65
59 to run celery beat:
66 To run celery beat:
60
67
61 celery beat -A appenlight.celery --ini FILENAME.ini
68 celery beat -A appenlight.celery --ini FILENAME.ini
62
69
63 to run appenlight's uptime plugin:
70 To run appenlight's uptime plugin:
64
71
65 appenlight-uptime-monitor -c FILENAME.ini
72 appenlight-uptime-monitor -c FILENAME.ini
73
74 Real-time Notifications
75 =======================
76
77 You should also run the `channelstream websocket server for real-time notifications
78
79 channelstream -i filename.ini
80
81 Testing
82 =======
83
84 To run test suite:
85
86 py.test appenlight/tests/tests.py --cov appenlight (this looks for testing.ini in repo root)
87
88
89 Development
90 ===========
91
92 To develop appenlight frontend:
93
94 cd frontend
95 npm install
96 bower install
97 grunt watch
@@ -5,7 +5,7 b' import re'
5 from setuptools import setup, find_packages
5 from setuptools import setup, find_packages
6
6
7 here = os.path.abspath(os.path.dirname(__file__))
7 here = os.path.abspath(os.path.dirname(__file__))
8 README = open(os.path.join(here, 'README.md')).read()
8 README = open(os.path.join(here, '..', 'README.md')).read()
9 CHANGES = open(os.path.join(here, 'CHANGELOG.rst')).read()
9 CHANGES = open(os.path.join(here, 'CHANGELOG.rst')).read()
10
10
11 REQUIREMENTS = open(os.path.join(here, 'requirements.txt')).readlines()
11 REQUIREMENTS = open(os.path.join(here, 'requirements.txt')).readlines()
1 NO CONTENT: file was removed
NO CONTENT: file was removed
General Comments 0
You need to be logged in to leave comments. Login now