[github/shaarli/Shaarli.git] / doc / Directory-structure.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title>Shaarli – Directory structure</title>
  <style type="text/css">code{white-space: pre;}</style>
  <style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  </style>
  <link rel="stylesheet" href="github-markdown.css">
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<div id="local-sidebar">
<ul>
<li><a href="Home.html">Home</a></li>
<li>Installation
<ul>
<li><a href="Download.html">Download</a></li>
<li><a href="Server-requirements.html">Server requirements</a></li>
<li><a href="Server-configuration.html">Server configuration</a></li>
<li><a href="Server-security.html">Server security</a></li>
<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
<li><a href="Plugins.html">Plugins</a></li>
</ul></li>
<li><a href="Docker.html">Docker</a></li>
<li><a href="Usage.html">Usage</a>
<ul>
<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
<li><a href="Firefox-share.html">Firefox share</a></li>
<li><a href="RSS-feeds.html">RSS feeds</a></li>
</ul></li>
<li>How To
<ul>
<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
<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>
<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
</ul></li>
<li><a href="Troubleshooting.html">Troubleshooting</a></li>
<li><a href="Development.html">Development</a>
<ul>
<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
<li><a href="Directory-structure.html">Directory structure</a></li>
<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
<li><a href="Plugin-System.html">Plugin System</a></li>
<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
<li><a href="Security.html">Security</a></li>
<li><a href="Static-analysis.html">Static analysis</a></li>
<li><a href="Theming.html">Theming</a></li>
<li><a href="Unit-tests.html">Unit tests</a></li>
</ul></li>
<li>About
<ul>
<li><a href="FAQ.html">FAQ</a></li>
<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
<li><a href="TODO.html">TODO</a></li>
</ul></li>
</ul>
</div>
<h1 id="directory-structure">Directory structure</h1>
<p>Here is the directory structure of Shaarli and the purpose of the different files:</p>
<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">    <span class="kw">index.php</span>        <span class="co"># Main program</span>
    <span class="kw">application/</span>     <span class="co"># Shaarli classes</span>
        ├── <span class="kw">LinkDB.php</span>
        └── <span class="kw">Utils.php</span>
    <span class="kw">tests/</span>       <span class="co"># Shaarli unitary &amp; functional tests</span>
        ├── <span class="kw">LinkDBTest.php</span>
        ├── <span class="kw">utils</span>  <span class="co"># utilities to ease testing</span>
        │   └── <span class="kw">ReferenceLinkDB.php</span>
        └── <span class="kw">UtilsTest.php</span>
    <span class="kw">COPYING</span>          <span class="co"># Shaarli license</span>
    <span class="kw">inc/</span>             <span class="co"># static assets and 3rd party libraries</span>
        ├── <span class="kw">awesomplete.*</span>          <span class="co"># tags autocompletion library</span>
        ├── <span class="kw">blazy.*</span>                <span class="co"># picture wall lazy image loading library</span>
        ├── <span class="kw">shaarli.css</span>, reset.css <span class="co"># Shaarli stylesheet.</span>
        ├── <span class="kw">qr.*</span>                   <span class="co"># qr code generation library</span>
        └──<span class="kw">rain.tpl.class.php</span>      <span class="co"># RainTPL templating library</span>
    <span class="kw">tpl/</span>             <span class="co"># RainTPL templates for Shaarli. They are used to build the pages.</span>
    <span class="kw">images/</span>          <span class="co"># Images and icons used in Shaarli</span>
    <span class="kw">data/</span>            <span class="co"># data storage: bookmark database, configuration, logs, banlist…</span>
        ├── <span class="kw">config.php</span>             <span class="co"># Shaarli configuration (login, password, timezone, title…)</span>
        ├── <span class="kw">datastore.php</span>          <span class="co"># Your link database (compressed).</span>
        ├── <span class="kw">ipban.php</span>              <span class="co"># IP address ban system data</span>
        ├── <span class="kw">lastupdatecheck.txt</span>    <span class="co"># Update check timestamp file</span>
        └──<span class="kw">log.txt</span>                 <span class="co"># login/IPban log.</span>
    <span class="kw">cache/</span>           <span class="co"># thumbnails cache</span>
                     <span class="co"># This directory is automatically created. You can erase it anytime you want.</span>
    <span class="kw">tmp/</span>             <span class="co"># Temporary directory for compiled RainTPL templates.</span>
                     <span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div>
</body>
</html>
Commit	Line	Data
992af0b9 V	1	<!DOCTYPE html>
	2	<html>
	3	<head>
	4	<meta charset="utf-8">
	5	<meta name="generator" content="pandoc">
	6	<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
5409ade2	7	<title>Shaarli – Directory structure</title>
992af0b9	8	<style type="text/css">code{white-space: pre;}</style>
992af0b9	9	<style type="text/css">
5409ade2	10	div.sourceCode { overflow-x: auto; }
992af0b9 V	11	table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
	12	margin: 0; padding: 0; vertical-align: baseline; border: none; }
	13	table.sourceCode { width: 100%; line-height: 100%; }
	14	td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
	15	td.sourceCode { padding-left: 5px; }
5409ade2 A	16	code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
	17	code > span.dt { color: #902000; } /* DataType */
	18	code > span.dv { color: #40a070; } /* DecVal */
	19	code > span.bn { color: #40a070; } /* BaseN */
	20	code > span.fl { color: #40a070; } /* Float */
	21	code > span.ch { color: #4070a0; } /* Char */
	22	code > span.st { color: #4070a0; } /* String */
	23	code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
	24	code > span.ot { color: #007020; } /* Other */
	25	code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
	26	code > span.fu { color: #06287e; } /* Function */
	27	code > span.er { color: #ff0000; font-weight: bold; } /* Error */
	28	code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
	29	code > span.cn { color: #880000; } /* Constant */
	30	code > span.sc { color: #4070a0; } /* SpecialChar */
	31	code > span.vs { color: #4070a0; } /* VerbatimString */
	32	code > span.ss { color: #bb6688; } /* SpecialString */
	33	code > span.im { } /* Import */
	34	code > span.va { color: #19177c; } /* Variable */
	35	code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
	36	code > span.op { color: #666666; } /* Operator */
	37	code > span.bu { } /* BuiltIn */
	38	code > span.ex { } /* Extension */
	39	code > span.pp { color: #bc7a00; } /* Preprocessor */
	40	code > span.at { color: #7d9029; } /* Attribute */
	41	code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
	42	code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
	43	code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
	44	code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
992af0b9 V	45	</style>
992af0b9 V	46	<link rel="stylesheet" href="github-markdown.css">
5409ade2 A	47	<!--[if lt IE 9]>
	48	<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
	49	<![endif]-->
992af0b9 V	50	</head>
	51	<body>
	52	<div id="local-sidebar">
	53	<ul>
	54	<li><a href="Home.html">Home</a></li>
	55	<li>Installation
	56	<ul>
f8b936e7	57	<li><a href="Download.html">Download</a></li>
992af0b9 V	58	<li><a href="Server-requirements.html">Server requirements</a></li>
992af0b9 V	59	<li><a href="Server-configuration.html">Server configuration</a></li>
5409ade2 A	60	<li><a href="Server-security.html">Server security</a></li>
5409ade2 A	61	<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
992af0b9	62	<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea	63	<li><a href="Plugins.html">Plugins</a></li>
992af0b9	64	</ul></li>
5409ade2	65	<li><a href="Docker.html">Docker</a></li>
992af0b9 V	66	<li><a href="Usage.html">Usage</a>
	67	<ul>
	68	<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
5409ade2	69	<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
992af0b9 V	70	<li><a href="Firefox-share.html">Firefox share</a></li>
	71	<li><a href="RSS-feeds.html">RSS feeds</a></li>
	72	</ul></li>
	73	<li>How To
	74	<ul>
	75	<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
5409ade2	76	<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
992af0b9	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>
5409ade2	78	<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
992af0b9	79	<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
6335a0fc	80	<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
992af0b9 V	81	</ul></li>
	82	<li><a href="Troubleshooting.html">Troubleshooting</a></li>
	83	<li><a href="Development.html">Development</a>
	84	<ul>
	85	<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
	86	<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
	87	<li><a href="Directory-structure.html">Directory structure</a></li>
	88	<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
	89	<li><a href="Plugin-System.html">Plugin System</a></li>
5409ade2	90	<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
992af0b9 V	91	<li><a href="Security.html">Security</a></li>
	92	<li><a href="Static-analysis.html">Static analysis</a></li>
	93	<li><a href="Theming.html">Theming</a></li>
	94	<li><a href="Unit-tests.html">Unit tests</a></li>
	95	</ul></li>
	96	<li>About
	97	<ul>
	98	<li><a href="FAQ.html">FAQ</a></li>
	99	<li><a href="Community-&-Related-software.html">Community & Related software</a></li>
	100	<li><a href="TODO.html">TODO</a></li>
	101	</ul></li>
	102	</ul>
	103	</div>
	104	<h1 id="directory-structure">Directory structure</h1>
	105	<p>Here is the directory structure of Shaarli and the purpose of the different files:</p>
5409ade2	106	<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"> <span class="kw">index.php</span> <span class="co"># Main program</span>
992af0b9 V	107	<span class="kw">application/</span> <span class="co"># Shaarli classes</span>
	108	├── <span class="kw">LinkDB.php</span>
	109	└── <span class="kw">Utils.php</span>
	110	<span class="kw">tests/</span> <span class="co"># Shaarli unitary & functional tests</span>
	111	├── <span class="kw">LinkDBTest.php</span>
	112	├── <span class="kw">utils</span> <span class="co"># utilities to ease testing</span>
	113	│ └── <span class="kw">ReferenceLinkDB.php</span>
	114	└── <span class="kw">UtilsTest.php</span>
	115	<span class="kw">COPYING</span> <span class="co"># Shaarli license</span>
	116	<span class="kw">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>
	118	├── <span class="kw">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>
	120	├── <span class="kw">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>
	122	<span class="kw">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>
	124	<span class="kw">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>
	126	├── <span class="kw">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>
	128	├── <span class="kw">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>
	130	<span class="kw">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>
	132	<span class="kw">tmp/</span> <span class="co"># Temporary directory for compiled RainTPL templates.</span>
5409ade2	133	<span class="co"># This directory is automatically created. You can erase it anytime you want.</span></code></pre></div>
992af0b9 V	134	</body>
992af0b9 V	135	</html>