Skip to content

Server

Warning

The Bip server is under active development, and there is no automated installation process for the server. This step-by-step is for development purpose only.

Introduction

For now, the server only consists of a pre-populated Neo4j database, since Bip is still entirely living on the client side.

You must therefore prepare the server by manually installing and setting up the requirements, then you must connect to that database once from a client-type machine to initialize it with a script currently owned by the client database.

Requirements

Prepare Neo4j

Initialize the database

Clone the client repository, then create a venv with the client requirements and activate it:

git clone https://git.blinkink.co.uk/bip/client.git
cd client
python3.9 -m venv venv
source venv/bin/activate
pip install -r .\requirements.txt

Create a configuration file for Bip:

nano config.yml

Copy-paste and adapt the following configuration:

database:
  uri: bolt://your-server-ip-or-hostname:7687
  user: neo4j

Save the file, then create an installation script:

nano install.py

Copy-paste and adapt the following script:

from bip import link

link.tools.install(content_source="https://url.to/my/bip-content-repo.git")

Tip

Check the link.tools.install documentation for more information.

Save the file, then set the following environment variables (make sure you edit the path and the password)

export BIP_CONFIG=/path/to/client/config.yml
export BIP_DATABASE_PASSWORD=mypassword
export BIP_SERVER_MODE=true

Save the file.

Run the installation script:

python install.py

Once the installation is completed, you can delete the client directory.