Skip to content

Introduction

Bip requires a Git repository as the source of all configuration files, scripts and. That repository is called Content.

Adding files (configuration files, python modules, html pages, stylesheets, vendored resources...) to this repository is the designed method for adapting Bip to your Studio needs and preferences. For example, you can choose what application can be started from the launching application (Brioche by default) by writing your batch files, write your own tasks that will be loaded by the scene managing application (Moka by default)...

Warning

The content repository is mandatory, even if not used. It should be set up when you create your Bip instance. See the server installation documentation page.

It can be hosted anywhere, but must be reachable (via ssh and https) by all Bip clients.

On client machines, the Content repository is cloned by the updating application (Bugne by default), and checked out by the launching application (Brioche by default) when started, restarted (builtin command: restart) or reloaded (builtin command: reload).

Requirements

  • Public repository
  • Reachable from both ssh and https
  • At least a main branch

Tip

By default, the branch checked out by the Launcher is master. But the Launcher will always try to match the current Bip (client) branch, and will fall back to master if not found. Therefore, in your content repository, you can create as many branches as you want (typically, a develop one) and if there is a match, the Launcher will use it.

Directories

Bip will be looking for specific directories:

Folder name Description
commands Custom Launcher commands
config Config files
custom Applications customization files (UI presets, integrated documentation...)
batches Batches yml files
preset Various presets used by applications or scripts
python If it exists, this directory is appended to the PYTHONPATH, it is useful if you need to easily share modules (for Tasks for example)
tasks DCC tasks read by the flow API (bip.pink).

In order to keep your repository tidy, it is recommended, but not necessary, to also create the following useful directories. Because the root of the content repository is stored in an environment variable (BIP_CONTENT, see environment variables, those locations would be easy to access from custom scripts.

Folder name Description
assets Store your icons and images
misc Various files
vendor Any external content you might want to ship, typically, DCC plugins or addons deployed by some launchers