doc: update external links based on redirects, fix/remove dead links

- checked with python -m sphinx -b linkcheck -c doc doc/md doc/linkcheck

2023-10-05 15:02:00 +02:00

2.8 KiB

Raw Blame History

Installation

Once your server is configured, install Shaarli:

From release ZIP

To install Shaarli, simply place the files from the latest release .zip archive under your webserver's document root (directly at the document root, or in a subdirectory). Download the shaarli-vX.X.X-full archive to include dependencies.

wget https://github.com/shaarli/Shaarli/releases/download/v0.11.1/shaarli-v0.11.1-full.zip
unzip shaarli-v0.11.1-full.zip
sudo rsync -avP Shaarli/ /var/www/shaarli.mydomain.org/

From sources

These components are required to build Shaarli:

Composer to manage third-party PHP dependencies.
yarn to build frontend dependencies.
python3-virtualenv to build local HTML documentation.

# example from a Debian-based build machine
sudo apt install composer yarnpkg python3-virtualenv

Clone the repository, either pointing to:

any tagged release
latest: the latest tagged release
master: development branch

# clone the branch/tag of your choice
$ git clone -b latest https://github.com/shaarli/Shaarli.git /home/me/Shaarli
# OR download/extract the tar.gz/zip: wget https://github.com/shaarli/Shaarli/archive/latest.tar.gz...

# enter the directory
$ cd /home/me/Shaarli
# install 3rd-party PHP dependencies
$ composer install --no-dev --prefer-dist
# build frontend static assets
$ make build_frontend
# build translations
$ make translate
# build HTML documentation
$ make htmldoc
# copy the resulting shaarli directory under your webserver's document root
$ rsync -avP /home/me/Shaarli/ /var/www/shaarli.mydomain.org/

Set file permissions

Regardless of the installation method, appropriate file permissions must be set:

sudo chown -R root:www-data /var/www/shaarli.mydomain.org
sudo chmod -R g+rX /var/www/shaarli.mydomain.org
sudo chmod -R g+rwX /var/www/shaarli.mydomain.org/{cache/,data/,pagecache/,tmp/}