diff options
Diffstat (limited to 'doc/Directory-structure.html')
| -rw-r--r-- | doc/Directory-structure.html | 60 |
1 files changed, 29 insertions, 31 deletions
diff --git a/doc/Directory-structure.html b/doc/Directory-structure.html index 003d4d94..404ff7c8 100644 --- a/doc/Directory-structure.html +++ b/doc/Directory-structure.html | |||
| @@ -52,13 +52,13 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 52 | <div id="local-sidebar"> | 52 | <div id="local-sidebar"> |
| 53 | <ul> | 53 | <ul> |
| 54 | <li><a href="Home.html">Home</a></li> | 54 | <li><a href="Home.html">Home</a></li> |
| 55 | <li>Installation | 55 | <li>Setup |
| 56 | <ul> | 56 | <ul> |
| 57 | <li><a href="Download.html">Download</a></li> | 57 | <li><a href="Download-and-Installation.html">Download and Installation</a></li> |
| 58 | <li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li> | ||
| 58 | <li><a href="Server-requirements.html">Server requirements</a></li> | 59 | <li><a href="Server-requirements.html">Server requirements</a></li> |
| 59 | <li><a href="Server-configuration.html">Server configuration</a></li> | 60 | <li><a href="Server-configuration.html">Server configuration</a></li> |
| 60 | <li><a href="Server-security.html">Server security</a></li> | 61 | <li><a href="Server-security.html">Server security</a></li> |
| 61 | <li><a href="Shaarli-installation.html">Shaarli installation</a></li> | ||
| 62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> | 62 | <li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> |
| 63 | <li><a href="Plugins.html">Plugins</a></li> | 63 | <li><a href="Plugins.html">Plugins</a></li> |
| 64 | </ul></li> | 64 | </ul></li> |
| @@ -73,7 +73,6 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 73 | <li>How To | 73 | <li>How To |
| 74 | <ul> | 74 | <ul> |
| 75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> | 75 | <li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> |
| 76 | <li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li> | ||
| 77 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> | 76 | <li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> |
| 78 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> | 77 | <li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li> |
| 79 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> | 78 | <li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> |
| @@ -97,39 +96,38 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf | |||
| 97 | <ul> | 96 | <ul> |
| 98 | <li><a href="FAQ.html">FAQ</a></li> | 97 | <li><a href="FAQ.html">FAQ</a></li> |
| 99 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> | 98 | <li><a href="Community-&-Related-software.html">Community & Related software</a></li> |
| 100 | <li><a href="TODO.html">TODO</a></li> | ||
| 101 | </ul></li> | 99 | </ul></li> |
| 102 | </ul> | 100 | </ul> |
| 103 | </div> | 101 | </div> |
| 104 | <h1 id="directory-structure">Directory structure</h1> | 102 | <h1 id="directory-structure">Directory structure</h1> |
| 105 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> | 103 | <p>Here is the directory structure of Shaarli and the purpose of the different files:</p> |
| 106 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">index.php</span> <span class="co"># Main program</span> | 104 | <div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="ex">index.php</span> <span class="co"># Main program</span> |
| 107 | <span class="kw">application/</span> <span class="co"># Shaarli classes</span> | 105 | <span class="ex">application/</span> <span class="co"># Shaarli classes</span> |
| 108 | ├── <span class="kw">LinkDB.php</span> | 106 | ├── <span class="ex">LinkDB.php</span> |
| 109 | └── <span class="kw">Utils.php</span> | 107 | └── <span class="ex">Utils.php</span> |
| 110 | <span class="kw">tests/</span> <span class="co"># Shaarli unitary & functional tests</span> | 108 | <span class="ex">tests/</span> <span class="co"># Shaarli unitary & functional tests</span> |
| 111 | ├── <span class="kw">LinkDBTest.php</span> | 109 | ├── <span class="ex">LinkDBTest.php</span> |
| 112 | ├── <span class="kw">utils</span> <span class="co"># utilities to ease testing</span> | 110 | ├── <span class="ex">utils</span> <span class="co"># utilities to ease testing</span> |
| 113 | │ └── <span class="kw">ReferenceLinkDB.php</span> | 111 | │ └── <span class="ex">ReferenceLinkDB.php</span> |
| 114 | └── <span class="kw">UtilsTest.php</span> | 112 | └── <span class="ex">UtilsTest.php</span> |
| 115 | <span class="kw">COPYING</span> <span class="co"># Shaarli license</span> | 113 | <span class="ex">COPYING</span> <span class="co"># Shaarli license</span> |
| 116 | <span class="kw">inc/</span> <span class="co"># static assets and 3rd party libraries</span> | 114 | <span class="ex">inc/</span> <span class="co"># static assets and 3rd party libraries</span> |
| 117 | ├── <span class="kw">awesomplete.*</span> <span class="co"># tags autocompletion library</span> | 115 | ├── <span class="ex">awesomplete.*</span> <span class="co"># tags autocompletion library</span> |
| 118 | ├── <span class="kw">blazy.*</span> <span class="co"># picture wall lazy image loading library</span> | 116 | ├── <span class="ex">blazy.*</span> <span class="co"># picture wall lazy image loading library</span> |
| 119 | ├── <span class="kw">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span> | 117 | ├── <span class="ex">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span> |
| 120 | ├── <span class="kw">qr.*</span> <span class="co"># qr code generation library</span> | 118 | ├── <span class="ex">qr.*</span> <span class="co"># qr code generation library</span> |
| 121 | └──<span class="kw">rain.tpl.class.php</span> <span class="co"># RainTPL templating library</span> | 119 | └──<span class="ex">rain.tpl.class.php</span> <span class="co"># RainTPL templating library</span> |
| 122 | <span class="kw">tpl/</span> <span class="co"># RainTPL templates for Shaarli. They are used to build the pages.</span> | 120 | <span class="ex">tpl/</span> <span class="co"># RainTPL templates for Shaarli. They are used to build the pages.</span> |
| 123 | <span class="kw">images/</span> <span class="co"># Images and icons used in Shaarli</span> | 121 | <span class="ex">images/</span> <span class="co"># Images and icons used in Shaarli</span> |
| 124 | <span class="kw">data/</span> <span class="co"># data storage: bookmark database, configuration, logs, banlist…</span> | 122 | <span class="ex">data/</span> <span class="co"># data storage: bookmark database, configuration, logs, banlist…</span> |
| 125 | ├── <span class="kw">config.php</span> <span class="co"># Shaarli configuration (login, password, timezone, title…)</span> | 123 | ├── <span class="ex">config.php</span> <span class="co"># Shaarli configuration (login, password, timezone, title…)</span> |
| 126 | ├── <span class="kw">datastore.php</span> <span class="co"># Your link database (compressed).</span> | 124 | ├── <span class="ex">datastore.php</span> <span class="co"># Your link database (compressed).</span> |
| 127 | ├── <span class="kw">ipban.php</span> <span class="co"># IP address ban system data</span> | 125 | ├── <span class="ex">ipban.php</span> <span class="co"># IP address ban system data</span> |
| 128 | ├── <span class="kw">lastupdatecheck.txt</span> <span class="co"># Update check timestamp file</span> | 126 | ├── <span class="ex">lastupdatecheck.txt</span> <span class="co"># Update check timestamp file</span> |
| 129 | └──<span class="kw">log.txt</span> <span class="co"># login/IPban log.</span> | 127 | └──<span class="ex">log.txt</span> <span class="co"># login/IPban log.</span> |
| 130 | <span class="kw">cache/</span> <span class="co"># thumbnails cache</span> | 128 | <span class="ex">cache/</span> <span class="co"># thumbnails cache</span> |
| 131 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> | 129 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span> |
| 132 | <span class="kw">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span> | 130 | <span class="ex">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span> |
| 133 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div> | 131 | <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div> |
| 134 | </body> | 132 | </body> |
| 135 | </html> | 133 | </html> |