Home
QuadPype is an open source pipeline for all kinds of productions (2D, 3D, VFX, ...).
In the following documentation pages you will find all the details to install, configure and start using QuadPype.
To use QuadPype two elements accessible by ALL your users are mandatory :
A MongoDB instance need to run 24/7, It's the keystone element. Its store your projects info, published elements info, QuadPype settings (studio, projects, users), ...
Multiples options exists to achieve this:
- (Cloud) Use the MongoDB cloud solution named Altas to create and configure a MongoDB instance.
- (Cloud) Deploy a MongoDB Docker container online, using a cloud platform you can get a container running with your MongoDB instance accessible very easily.
- (On Site) Deploy a MongoDB Docker container on a server you manage.
Either way at the end QuadPype will need the MongoDB connection string, something formatted like this:
mongodb+srv://<username>:<password>@<url>/
The elements surrounded by <> need to be replaced.
NOTE: The <username>:<password> is highly recommended but not mandatory
Storing and accessing the projects with all the files produced by the artists require a server accessible to all the machines (local and remote) using QuadPype.
It's not necessary that this server is mounted (Linux, MacOS) or mapped to a drive letter (Windows), it's only required that the server is accessible. You can have an internal VPN, and when users are logged-in they can read and write to one of your web server, in that case the server IP will work fine.
NOTE: For testing purpose you can configure QuadPype to use a local directory on your machine
Now that the requirements are fulfilled, the installation process is very simple.
- Download the latest installer for your platform.
- Install it by following the steps of the installer.
DONE
Before your team and yourself can start enjoy the power of QuadPype, the configuration need to be made. Configuring QuadPype isn't complexe but crucial for your pipeline to work properly.
