diff options
author | VirtualTam <virtualtam@flibidi.net> | 2017-07-29 15:29:54 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2017-07-29 15:33:35 +0200 |
commit | 3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a (patch) | |
tree | a5f9a26ce2033182fd0d13c9035b44ff9ebbf9fe /doc/html/Shaarli-configuration | |
parent | 84d0632a2df1cf833610bc8dd45d4808e4a8dc0e (diff) | |
download | Shaarli-3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a.tar.gz Shaarli-3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a.tar.zst Shaarli-3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a.zip |
Generate HTML documentation
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/html/Shaarli-configuration')
-rw-r--r-- | doc/html/Shaarli-configuration/index.html | 60 |
1 files changed, 36 insertions, 24 deletions
diff --git a/doc/html/Shaarli-configuration/index.html b/doc/html/Shaarli-configuration/index.html index 4e556061..cd323a32 100644 --- a/doc/html/Shaarli-configuration/index.html +++ b/doc/html/Shaarli-configuration/index.html | |||
@@ -134,19 +134,19 @@ | |||
134 | <ul class="subnav"> | 134 | <ul class="subnav"> |
135 | <li class=""> | 135 | <li class=""> |
136 | 136 | ||
137 | <a class="" href="../Docker-101/">Docker 101</a> | 137 | <a class="" href="../docker/docker-101/">Docker 101</a> |
138 | </li> | 138 | </li> |
139 | <li class=""> | 139 | <li class=""> |
140 | 140 | ||
141 | <a class="" href="../Shaarli-images/">Shaarli images</a> | 141 | <a class="" href="../docker/shaarli-images/">Shaarli images</a> |
142 | </li> | 142 | </li> |
143 | <li class=""> | 143 | <li class=""> |
144 | 144 | ||
145 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | 145 | <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a> |
146 | </li> | 146 | </li> |
147 | <li class=""> | 147 | <li class=""> |
148 | 148 | ||
149 | <a class="" href="../Docker-resources/">Docker resources</a> | 149 | <a class="" href="../docker/resources/">Docker resources</a> |
150 | </li> | 150 | </li> |
151 | </ul> | 151 | </ul> |
152 | </li> | 152 | </li> |
@@ -323,26 +323,38 @@ | |||
323 | <em> its values override those defined in <code>index.php</code> | 323 | <em> its values override those defined in <code>index.php</code> |
324 | </em> it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration</p> | 324 | </em> it is wrap in a PHP comment to prevent anyone accessing it, regardless of server configuration</p> |
325 | <h2 id="file-and-directory-permissions">File and directory permissions</h2> | 325 | <h2 id="file-and-directory-permissions">File and directory permissions</h2> |
326 | <p>The server process running Shaarli must have: | 326 | <p>The server process running Shaarli must have:</p> |
327 | - <code>read</code> access to the following resources: | 327 | <ul> |
328 | - PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code> | 328 | <li><code>read</code> access to the following resources:<ul> |
329 | - 3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code> | 329 | <li>PHP scripts: <code>index.php</code>, <code>application/*.php</code>, <code>plugins/*.php</code></li> |
330 | - static assets: | 330 | <li>3rd party PHP and Javascript libraries: <code>inc/*.php</code>, <code>inc/*.js</code></li> |
331 | - CSS stylesheets: <code>inc/*.css</code> | 331 | <li>static assets:<ul> |
332 | - <code>images/*</code> | 332 | <li>CSS stylesheets: <code>inc/*.css</code></li> |
333 | - RainTPL templates: <code>tpl/*.html</code> | 333 | <li><code>images/*</code></li> |
334 | - <code>read</code>, <code>write</code> and <code>execution</code> access to the following directories: | 334 | </ul> |
335 | - <code>cache</code> - thumbnail cache | 335 | </li> |
336 | - <code>data</code> - link data store, configuration options | 336 | <li>RainTPL templates: <code>tpl/*.html</code></li> |
337 | - <code>pagecache</code> - Atom/RSS feed cache | 337 | </ul> |
338 | - <code>tmp</code> - RainTPL page cache</p> | 338 | </li> |
339 | <p>On a Linux distribution: | 339 | <li><code>read</code>, <code>write</code> and <code>execution</code> access to the following directories:<ul> |
340 | - the web server user will likely be <code>www</code> or <code>http</code> (for Apache2) | 340 | <li><code>cache</code> - thumbnail cache</li> |
341 | - it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code> | 341 | <li><code>data</code> - link data store, configuration options</li> |
342 | - to give it access to Shaarli, either: | 342 | <li><code>pagecache</code> - Atom/RSS feed cache</li> |
343 | - unzip Shaarli in the default web server location (usually <code>/var/www/</code>) and set the web server user as the owner | 343 | <li><code>tmp</code> - RainTPL page cache</li> |
344 | - put users in the same group as the web server, and set the appropriate access rights | 344 | </ul> |
345 | - if you have a domain / subdomain to serve Shaarli, <a href="../Server-configuration">configure the server</a> accordingly<a href="../.html"></a></p> | 345 | </li> |
346 | </ul> | ||
347 | <p>On a Linux distribution:</p> | ||
348 | <ul> | ||
349 | <li>the web server user will likely be <code>www</code> or <code>http</code> (for Apache2)</li> | ||
350 | <li>it will be a member of a group of the same name: <code>www:www</code>, <code>http:http</code></li> | ||
351 | <li>to give it access to Shaarli, either:<ul> | ||
352 | <li>unzip Shaarli in the default web server location (usually <code>/var/www/</code>) and set the web server user as the owner</li> | ||
353 | <li>put users in the same group as the web server, and set the appropriate access rights</li> | ||
354 | </ul> | ||
355 | </li> | ||
356 | <li>if you have a domain / subdomain to serve Shaarli, <a href="../Server-configuration">configure the server</a> accordingly<a href="../.html"></a></li> | ||
357 | </ul> | ||
346 | <h2 id="configuration">Configuration</h2> | 358 | <h2 id="configuration">Configuration</h2> |
347 | <p>In <code>data/config.json.php</code>.</p> | 359 | <p>In <code>data/config.json.php</code>.</p> |
348 | <p>See also <a href="../Plugin-System.html">Plugin System</a>.</p> | 360 | <p>See also <a href="../Plugin-System.html">Plugin System</a>.</p> |