Browse Source

solves #141 : Updated README + make README present at install

README is now present in $(datadir)/doc/lodel2/
And as README.gz in /usr/share/doc/lodel2/ for debian packages
Yann Weber 8 years ago
parent
commit
96d871fed5
2 changed files with 50 additions and 6 deletions
  1. 5
    3
      Makefile.am
  2. 45
    3
      README

+ 5
- 3
Makefile.am View File

@@ -1,5 +1,5 @@
1 1
 SUBDIRS = lodel progs plugins
2
-EXTRA_DIST = plugins runtest examples tests README runtest.sh debian
2
+EXTRA_DIST = plugins runtest examples tests runtest.sh debian
3 3
 CLEANFILES = runtest
4 4
 
5 5
 lodel2_localstate_DATA =
@@ -12,8 +12,10 @@ install_model_dir = $(lodel2datadir)/install_model
12 12
 python=@PYTHON@
13 13
 dyncode_filename='lodel/leapi/dyncode.py'
14 14
 
15
+docdir=${datarootdir}/doc/lodel2
16
+
15 17
 # Doxygen doc generation targets
16
-doc:
18
+doxygen:
17 19
 	test -z "@DOCOK@" && echo -e "\n\nUnable to generate documentation. See ./configure output for details\n\n" >&2 || make generate-doc
18 20
 
19 21
 generate-doc: clean doc_graphviz
@@ -31,7 +33,7 @@ runtest: runtest.sh
31 33
 
32 34
 #Adding logdir creation on install
33 35
 install-data-hook:
34
-	mkdir -p ${DESTDIR}$(lodel2_localstatedir)
36
+	mkdir -p ${DESTDIR}$(lodel2_localstatedir); mkdir -p ${DESTDIR}$(docdir); cp README ${DESTDIR}$(docdir);
35 37
 
36 38
 #Making debian package
37 39
 deb: dist

+ 45
- 3
README View File

@@ -33,12 +33,17 @@ Build & install :
33 33
 	#Uninstall lodel2
34 34
 	make uninstall
35 35
 
36
+Creating debian package :
37
+=========================
38
+
39
+	make deb
40
+
36 41
 Other make targets :
37 42
 ====================
38 43
 
39 44
 	Doxygen documentation generation :
40 45
 	----------------------------------
41
-		make doc #or simply run doxygen in the source dir
46
+		make doxygen
42 47
 
43 48
 	Run unit tests :
44 49
 	----------------
@@ -46,6 +51,11 @@ Other make targets :
46 51
 		make check
47 52
 		#or
48 53
 		make unittest
54
+	
55
+	Cleaning to stop being annoyed when running git status :
56
+	--------------------------------------------------------
57
+		
58
+		make gitclean
49 59
 
50 60
 Lodel2 instance management utilities :
51 61
 ======================================
@@ -88,9 +98,11 @@ Lodel2 instance management utilities :
88 98
 		Use for easy mass deployment of instances with webui & uwsgi
89 99
 		the script at $prefix/share/lodel2/scripts/mass_deploy.sh
90 100
 
91
-		Usage : mass_deploy.sh N #with N the number of instances to deploy
101
+		Usage : 
92 102
 		-------
93
-		
103
+			#with N the number of instances to deploy
104
+			mass_deploy.sh N 		
105
+
94 106
 		Notes :
95 107
 		-------
96 108
 
@@ -100,6 +112,36 @@ Lodel2 instance management utilities :
100 112
 		- mass deploy create instances directories 
101 113
 		  in /tmp/lodel2_instances
102 114
 
115
+Mass deployments tricks & tips:
116
+===============================
117
+
118
+	Mass deployment on fresh install :
119
+	----------------------------------
120
+
121
+	#Add an admin user to mongodb and activate auth
122
+	#Deploying 50 instances
123
+	NINSTANCE=50
124
+	#Indicate mongodb credentials to mass_deploy
125
+	vim /etc/lodel2/mass_deploy.cfg
126
+	#Running mass_deploy
127
+	/usr/share/lodel2/scripts/mass_deploy $NINSTANCE
128
+	#Updating nginx conf (delete /etc/nginx/sites-enabled/default if exists)
129
+	slim --nginx-conf -a > /etc/nginx/sites-enabled/lodel2
130
+	/etc/init.d/nginx reload
131
+	#Start all instances and check if they managed to start
132
+	slim --start -a && sleep 2 && slim -l
133
+
134
+
135
+	Cleaning mongodb + instances :
136
+	------------------------------
137
+
138
+	slim --purge && /usr/share/lodel2/scripts/mass_deploy purgedb ; slim -l
139
+
140
+	Debuging an instance in foreground (if it didn't manage to start) :
141
+	-------------------------------------------------------------------
142
+
143
+	slim --start -f -n INSTANCE_NAME
144
+
103 145
 Instance operations :
104 146
 =====================
105 147
 

Loading…
Cancel
Save