WARNING The following guide is intended for developers to set-up Multiwoven locally. If you are a user, please refer to the Self-Hosted guide.

​
Prerequisites

Note: if you are using Mac or Windows, you will need to install Docker Desktop instead of just docker. Docker Desktop includes both docker and docker-compose.

Verify that you have the correct versions installed:

docker --version
docker-compose --version

​
Installation

  1. Clone the repository
git clone git@github.com:Multiwoven/multiwoven.git
  1. Navigate to the multiwoven directory
cd multiwoven
  1. Initialize .env file
cp .env.example .env
Note: Refer to the Environment Variables section for details on the ENV variables used in the Docker environment.
  1. Build docker images
docker-compose build
Note: The default build architecture is for x86_64. If you are using arm64 architecture, you will need to run the below command to build the images for arm64.
TARGETARCH=arm64 docker-compose
  1. Start the containers
docker-compose up
  1. Stop the containers
docker-compose down

​
Usage

Once the containers are running, you can access the Multiwoven UI at http://localhost:8000.

The multiwoven API is available at http://localhost:3000/api/v1.

​
Running Tests

  1. Running the complete test suite on the multiwoven server
docker-compose exec multiwoven-server bundle exec rspec

​
Troubleshooting

To cleanup all images and containers, run the following commands:

docker rmi -f $(docker images -q)
docker rm -f $(docker ps -a -q)

prune all unused images, containers, networks and volumes

Danger: This will remove all unused images, containers, networks and volumes.
docker system prune -a

Please open a new issue at https://github.com/Multiwoven/multiwoven/issues if you run into any issues or join our Slack to chat with us.

Was this page helpful?

Environment VariablesDocker