@@ -13,7 +13,8 @@ Coil requires Nikola to work. `Nikola`_ is a static site generator, written
13
13
in Python. Coil manages the files that are then used by Nikola to build the
14
14
site.
15
15
16
- As such, you must configure Nikola first before you start Coil.
16
+ As such, you must configure Nikola first before you start Coil. You can also
17
+ use an existing site.
17
18
18
19
Virtualenv
19
20
==========
@@ -113,6 +114,8 @@ created by creating a similar dict. Password hashes can be calculated on the
113
114
(users should provide you with hashes and you must add them manually and
114
115
restart Coil) — consider not setting ``must_change_password `` in Limited mode.
115
116
117
+ **Continue ** with `First build `_.
118
+
116
119
Configuring Full Mode
117
120
---------------------
118
121
@@ -177,7 +180,10 @@ The default URL is ``redis://localhost:6379/0``.
177
180
First build
178
181
===========
179
182
180
- When you are done configuring Nikola and Coil, run ``nikola build ``.
183
+ When you are done configuring Nikola, Coil and any other dependencies, run
184
+ ``nikola build ``. This will build an empty Nikola site that can now be hosted
185
+ outside. You need to do this, because Coil itself uses some assets from this
186
+ site.
181
187
182
188
.. code-block :: console
183
189
@@ -198,14 +204,26 @@ Make sure to fix permissions if you fool around the site directory!
198
204
Server
199
205
======
200
206
201
- For testing purposes, you can use ``coil devserver ``. It should **NOT ** be used
202
- in production. You should use uWSGI Emperor and nginx in a real environment.
207
+ Built-in development server
208
+ ---------------------------
209
+
210
+ For testing purposes, or for ad-hoc usage (especially in Limited mode), you can
211
+ just run ``coil devserver ``. However, it should **NOT ** be used in production.
212
+ In a public environment, especially in Full mode, you should use uWSGI Emperor
213
+ and nginx instead.
203
214
204
215
uWSGI
205
216
-----
206
217
207
218
Sample uWSGI configuration:
208
219
220
+ .. note ::
221
+
222
+ ``python2 `` may also be ``python ``, depending on your environment.
223
+
224
+ .. warning ::
225
+
226
+ ``processes `` **MUST ** be set to 1 if running in Limited Mode.
209
227
210
228
.. code-block :: ini
211
229
@@ -225,18 +243,18 @@ Sample uWSGI configuration:
225
243
processes = 3
226
244
logger = file:/var/coil/my_coil_site/uwsgi.log
227
245
228
- .. note ::
246
+ nginx
247
+ -----
229
248
230
- `` python2 `` may also be `` python `` depending on your environment.
249
+ Sample nginx configuration:
231
250
232
251
.. note ::
233
252
234
- ``processes `` MUST be set to 1 if running in Limited Mode.
253
+ This configuration block assumes you followed the guide. You may need to
254
+ change the location aliases to match your system.
235
255
236
- nginx
237
- -----
238
-
239
- Sample nginx configuration:
256
+ You should change ``server_name `` to something you own and can run the
257
+ server on.
240
258
241
259
.. code-block :: nginx
242
260
@@ -267,4 +285,13 @@ Sample nginx configuration:
267
285
}
268
286
}
269
287
288
+ Other web servers
289
+ -----------------
290
+
291
+ You can also use any other web or WSGI server. You must take care of:
292
+
293
+ * location aliases for ``/favicon.ico ``, ``/assets ``, ``/coil_assets`,
294
+ ``/bower_components `` — see above for sample destinations
295
+ * correct process count (must be 1 in Limited mode)
296
+
270
297
.. _Nikola : https://getnikola.com/
0 commit comments