Install¶

Get the sources¶

On the server, download Phraseanet sources from the download page of Phraseanet.com then unpack the Zip file to the chosen install directory.

For example, this can be done with the following commands:

wget --no-check-certificate https://www.phraseanet.com/builds/alchemy-fr-Phraseanet-v4.0.x.zip

And

unzip alchemy-fr-Phraseanet-v4.0.x.zip

Although it is not mandatory (but highly recommended), verify prerequisites using the following command at the root of Phraseanet install directory:

php bin/setup check:system

This command performs a check of the environment. It lists the points that need to be corrected to install successfully the application.

Web server configuration¶

Depending on the used web server, consult the corresponding configuration notes to configure it:

NGINX
Apache

Creating databases for Phraseanet¶

It is necessary to create two databases in order to initialize Phraseanet. These databases are used for:

The Application Box
The Databox

The database server used can be a local or a remote server.

Note

Depending on your choices, it may be necessary to create a specific MySQL user to exploit the created databases for Phraseanet.

Setup¶

Phraseanet can be installed in two ways:

In Command-line mode

Or

In graphic mode

Install in command-line¶

Phraseanet features a built in setup system command-line.

Run the following command at the root of Phraseanet install directory:

bin/setup system:install

The installation process starts.

If the two required databases are available, continue, otherwise create them
Provide the login information to the database server, and specify the name of the database operated by the Phraseanet Application box.
Indicate the name of the database operated by the Phraseanet Data box
Indicate a language (en for english, fr for french) to use for documentaries fields
Create an administrator account: enter a valid email address and a password for connection.

Note

Please note that the provided email address is used as the account identifier.

Set the media storage path

Note

To use the default storage path, answer N
To use another directory, answer y. The directory must exists and Phraseanet application must be able to read and write in it.

Provide an URL for the Phraseanet instance server
Start the installation process and wait until the Install successful message

Note

The build-in sample configuration fills parameters for a local Elasticsearch server using port 9200.

If necessary, edit the configuration file config/configuration.yml then compile the modified configuration.

Please, have a look to the Configuration page for more info.

Create Elasticsearch index

bin/console s:i:c

List Phrasenaet tasks

bin/console task-manager:task:list

Start Scheduler in a new Screen:

bin/console task-manager:scheduler:run -vvv

Phraseanet is now operational.

Install in graphic mode¶

For a GUI installation, launch a browser and go to the root URL of the application. User is redirected to /setup/installer/ page.

A set of screens containing forms helps to configure Phraseaent by collecting information related to binaries and storage paths, admin account or databases connection parameters.

Click on the Next button to start the procedure.

Check and modify if required banaries and execs paths then follow
Create an Administrator account for Phraseanet then follow

Note

The entered email address is used as the administrator account login.

Enter parameters for connection to the database dedicate to the Application box then follow
Provide a storage path for documents then follow

Note

The directory must exist and Phraseanet must be able to read and write in it.

Enter the name of the database for the Phraseanet Data box
Select the language to use for the initial documentaries fields (en for english, fr for french)
The installation program creates the necessary tasks to run the application. Leave the checkboxes checked.
Click on the Install button to start the installation script.
At the end of the process the user is leaded to the authentication page.
Login to Phraseanet with the account set previously to perform some post-installation settings.

Post-Installation settings¶

Setting search engine parameters¶

In Phraseanet Admin, click on Search engine parameters item
Adjust Elasticsearch setting according to context.
Create Elasticsearch index using the dedicated button.

Configure the Subview creation task¶

In Phraseanet Admin, click on Task Manager item
Select Edit item on the subviews creation task contextual drop down menu
Configure Databoxes and record types to be treated by the subviews creation task checking the appropriate checkboxes
Validate the form

Starting tasks manager.. is now required.

Tasks start¶

Tasks start can be done in the Task manager section in the Admin module of Phraseanet.

If the GUI install mode leads to this section after performing the whole setup, user performing the installation in command-line must login from the homepage of the application:

Reach the homepage of the application
Login using the Administrator account created in the setup step
Click on the Admin item in the Phraseanet menu bar
Click on the Task Manager item in the left side menu

To start tasks, click on the Start item in the contextual menu of Scheduler.

Note

Alternative method consists in using the bin/console commandline tool detailled here.

Congrats! Your install is finished!

To start using Phraseanet it is necessary to have at least one collection. Both set up procedures create a Phraseanet collection named test that can be used for tries.

Documentaries fields and subviews parameters can be adjusted to suit the needs of the project and documents can be added via Phraseanet Upload.

Navigation

Table Of Contents

Quick search

Install¶

Get the sources¶

Web server configuration¶

Creating databases for Phraseanet¶

Setup¶

Install in command-line¶

Install in graphic mode¶

Post-Installation settings¶

Setting search engine parameters¶

Configure the Subview creation task¶

Tasks start¶