friendica/friendica-directory
7
3
Fork 3
Code Issues 17 Pull requests Releases 17 Wiki Activity

Update INSTALL.md #10

Merged
AndyHee merged 5 commits from master into master 2018-11-14 16:08:47 +01:00
Conversation 23 Commits 5 Files changed 1 +20 -23
1 changed files with 20 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 247e444885 - Show all commits

43
INSTALL.md
View file

@ -1,36 +1,30 @@
# Friendica Directory Install # Friendica Directory Install Instructions
## Get the source code ## 1. Get the source code
If you want to install Friendica Directory in `/path/to/friendica-directory` For a planned install of Friendica Directory in the `/path/to/friendica-directory` folder.
### Using Composer ### Using Git and Composer
Composer is a popular dependency management tool for PHP projects. [Getting Started with Composer](https://getcomposer.org/doc/00-intro.md). Git is a popular version control management tool.
[Getting Started with Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
```
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](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
You'll also need Composer to grab the project dependencies. You'll also need Composer to grab the project dependencies.
Composer is a popular dependency management tool for PHP projects.
[Getting Started with Composer](https://getcomposer.org/doc/00-intro.md).
``` ```
cd /path/to cd /path/to
git clone https://github.com/friendica/friendica-directory git clone https://github.com/friendica/friendica-directory friendica-directory
cd friendica-directory cd friendica-directory
composer install composer install
``` ```
### Using an archive ### Using a stable release archive
On the [Friendica Directory Github Releases page](https://github.com/friendica/friendica-directory/releases), you can find the latest source archive named `friendica-directory-<version>.zip`. On the [Friendica Directory Github Releases page](https://github.com/friendica/friendica-directory/releases), you can find the latest source archive named `friendica-directory-<version>.zip`.
Simply unpack the archive in `/path/to/friendica-directory`. Simply unpack the archive in `/path/to/friendica-directory`, the dependencies are already included.
## Set up a database and a user ## Set up a database and a user
@ -45,7 +39,7 @@ Sample commands from the MariaDB console for a local install:
> GRANT ALL ON `friendica-directory`.* TO 'friendica-directory'@'localhost' IDENTIFIED BY "password"; > GRANT ALL ON `friendica-directory`.* TO 'friendica-directory'@'localhost' IDENTIFIED BY "password";
``` ```
## Initialize database schema ## 2. Initialize database schema
Using the details gathered from the previous step, follow the instructions in the Friendica Directory Install Wizard. Using the details gathered from the previous step, follow the instructions in the Friendica Directory Install Wizard.
@ -54,7 +48,7 @@ cd /path/to/friendica-directory
bin/console install bin/console install
``` ```
## Configure your web server ## 3. Configure your web server
The document root of Friendica Directory is `/public`. The document root of Friendica Directory is `/public`.
@ -67,13 +61,16 @@ In your Virtual Host file, set your document root as follow:
``` ```
DocumentRoot /path/to/friendica-directory/public/ DocumentRoot /path/to/friendica-directory/public/
MrPetovan commented 2018-11-14 15:47:46 +01:00 (Migrated from github.com)
Review
Copy link

Are you sure you need the q=$uri here?

Are you sure you need the `q=$uri` here?
AndyHee commented 2018-11-14 15:54:33 +01:00 (Migrated from github.com)
Review
Copy link

Not required. I removed it.

    try_files $uri /index.php?$args;

What about these ttf|woff|svg ?

Not required. I removed it. ```suggestion try_files $uri /index.php?$args; ``` What about these `ttf|woff|svg` ?
MrPetovan commented 2018-11-14 16:08:07 +01:00 (Migrated from github.com)
Review
Copy link

We use fontawesome so I would keep the mentions of the fonts and svg files.

We use fontawesome so I would keep the mentions of the fonts and svg files.
AndyHee commented 2018-11-14 16:09:03 +01:00 (Migrated from github.com)
Review
Copy link

OK. Thanks.

OK. Thanks.
``` ```
### Nginx ### Nginx
Include this line your nginx config file. Include this line your nginx config file.
<<<<<<< master
``` ```
root /path/to/friendica-directory/public; root /path/to/friendica-directory/public;
``` ```
## Set up the background task
## 4. Set up the background task
Friendica Directory relies on a background task running every minute to keep the directory up to date. Friendica Directory relies on a background task running every minute to keep the directory up to date.
@ -84,8 +81,8 @@ Add this line to your crontab:
* * * * * cd /path/to/friendica-directory && php bin/cron.php * * * * * cd /path/to/friendica-directory && php bin/cron.php
``` ```
## Seed your directory ## 5. Seed your directory
Your directory is ready, but empty. To start filling it, you can: Your directory is ready, but empty. To start filling it, you can:
- Set your hostname as the main directory in [Friendica](https://github.com/friendica/friendica)'s admin settings - Set your host name as the main directory in [Friendica](https://github.com/friendica/friendica)'s admin settings.
- Add existing directories in your polling queue: `bin/console directory-add https://dir.friendica.social` - Add existing directories in your polling queue: `bin/console directory-add https://dir.friendica.social`.