doc/md/Directory-structure.md

   1 TODO: This page is out of date
   2
   3 Here is the directory structure of Shaarli and the purpose of the different files:
   4
   5 ```bash
   6         index.php        # Main program
   7         application/     # Shaarli classes
   8                 ├── LinkDB.php
   9                 └── Utils.php
  10         tests/       # Shaarli unitary & functional tests
  11                 ├── LinkDBTest.php
  12                 ├── utils  # utilities to ease testing
  13                 │   └── ReferenceLinkDB.php
  14                 └── UtilsTest.php
  15     COPYING          # Shaarli license
  16     inc/             # static assets and 3rd party libraries
  17         ├── awesomplete.*          # tags autocompletion library
  18         ├── blazy.*                # picture wall lazy image loading library
  19         ├── shaarli.css, reset.css # Shaarli stylesheet.
  20         ├── qr.*                   # qr code generation library
  21         └──rain.tpl.class.php      # RainTPL templating library
  22     tpl/             # RainTPL templates for Shaarli. They are used to build the pages.
  23     images/          # Images and icons used in Shaarli
  24     data/            # data storage: bookmark database, configuration, logs, banlist…
  25         ├── config.php             # Shaarli configuration (login, password, timezone, title…)
  26         ├── datastore.php          # Your link database (compressed).
  27         ├── ipban.php              # IP address ban system data
  28         ├── lastupdatecheck.txt    # Update check timestamp file
  29         └──log.txt                 # login/IPban log.
  30     cache/           # thumbnails cache
  31                      # This directory is automatically created. You can erase it anytime you want.
  32     tmp/             # Temporary directory for compiled RainTPL templates.
  33                      # This directory is automatically created. You can erase it anytime you want.
  34 ```