2.7 KiB
Friendica Directory Install
Get the source code
If you want to install Friendica Directory in /path/to/friendica-directory
Using Composer
Composer is a popular dependency management tool for PHP projects. Getting Started with Composer.
cd /path/to
composer create-project friendica/friendica-directory --no-dev
Using Git
Git is a popular version control management tool. Getting Started with Git.
You'll also need Composer to grab the project dependencies.
cd /path/to
git clone https://github.com/friendica/friendica-directory
cd friendica-directory
composer install
Using an archive
On the Friendica Directory Github Releases page, you can find the latest source archive named friendica-directory-<version>.zip
.
Simply unpack the archive in /path/to/friendica-directory
.
Set up a database and a user
Friendica Directory supports MariaDB as a database provider. Getting started with MariaDB.
Once you have MariaDB installed on a given host, you need to create a database structure and a user with privileges on it.
Sample commands from the MariaDB console for a local install:
> CREATE DATABASE `friendica-directory`;
> GRANT ALL ON `friendica-directory`.* TO 'friendica-directory'@'localhost' IDENTIFIED BY "password";
Initialize database schema
Using the details gathered from the previous step, follow the instructions in the Friendica Directory Install Wizard.
cd /path/to/friendica-directory
bin/console install
Configure your web server
The document root of Friendica Directory is /public
.
Apache
Friendica Directory requires mod_rewrite
to be enabled.
In your Virtual Host file, set your document root as follow:
DocumentRoot /path/to/friendica-directory/public/
Nginx
Include this line your nginx config file.
root /path/to/friendica-directory/public;
Set up the background task
Friendica Directory relies on a background task running every minute to keep the directory up to date.
On Linux, you can set it up with Crontab, a popular background task scheduler. Getting started with Crontab.
Add this line to your crontab:
* * * * * cd /path/to/friendica-directory && php bin/cron.php
Seed your directory
Your directory is ready, but empty. To start filling it, you can:
- Set your hostname as the main directory in Friendica's admin settings
- Add existing directories in your polling queue:
bin/console directory-add https://dir.friendica.social