Below steps will guide you through deploying Multiwoven on a server using Docker Compose. We require PostgreSQL database to store meta data for Multiwoven. We will use Docker Compose to deploy Multiwoven and PostgreSQL.
Important Note: TLS is mandatory for deployment. To successfully deploy the Platform via docker-compose, you must have access to a DNS record and obtain a valid TLS certificate from a Certificate Authority. You can acquire a free TLS certificate using tools like CertBot, Let’s Encrypt, or other ACME-based solutions. If using a reverse proxy (e.g., Nginx or Traefik), consider integrating an automated certificate management tool such as letsencrypt-nginx-proxy-companion or Traefik’s built-in Let’s Encrypt support.
Note: If you are setting up Multiwoven on your local machine, you can skip this section and refer to
Local Setup section.
Prerequisites
All our Docker images are available in x86_64 architecture, make sure your server supports x86_64 architecture.
Deployment options
Multiwoven can be deployed using two different options for PostgreSQL database.
In-built PostgreSQL
Cloud PostgreSQL
- Create a new directory for Multiwoven and navigate to it.
- Download the production
docker-compose.yml file from the following link.
- Download the
.env.production file from the following link.
- Rename the file .env.production to .env and update the environment variables if required.
- Start the Multiwoven using the following command.
- Stopping Multiwoven
To stop the Multiwoven, use the following command.
- Upgrading Multiwoven
When a new version of Multiwoven is released, you can upgrade the Multiwoven using the following command. Make sure to run the above command from the same directory where the docker-compose.yml file is present.
-
Create a new directory for Multiwoven and navigate to it.
- Download the production
docker-compose.yml file from the following link.
- Rename the file .env.production to .env and update the PostgreSQL environment variables.
DB_HOST - Database Host
DB_USERNAME - Database Username
DB_PASSWORD - Database Password
The default port for PostgreSQL is 5432. If you are using a different port, update the DB_PORT environment variable.
- Start the Multiwoven using the following command.
Accessing Multiwoven
Once the Multiwoven is up and running, you can access it using the following URL and port.
Multiwoven Server URL:
Multiwoven UI Service:
If you are using a custom domain you can update the API_HOST and UI_HOST environment variable in the .env file.
Important considerations
-
Make sure to update the environment variables in the
.env file before starting the Multiwoven.
-
Make sure to take regular backups of the PostgreSQL database.
To restore the backup, you can use the following command.
- If you are using a custom domain, make sure to update the
API_HOST and UI_HOST environment variables in the .env file.
