Building and working with Malak Locally
Malak runs with very minimal hardware requirements by itself. While it
Malak has been tested and developed extensively on macOS but there are extremely high chances it works and compiles correcly on windows. Let us know if it does :)
To run Malak, you need to install a few things. Go, Node.js, bun, Git. We will not go through the installation of these as you can find them on their relative websites.
Step 1: Clone the Malak Repo
Navigate to the newly created malak
directory
This installs the dependencies you need: Postgresql, Redis, Minio, Grafana and Mailhog for local email testing
At the very minimum, you need to create a config.yml
containing the following:
You can find all possible configuration values here
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn’t align with the production version, please update the CLI:
This should go to your
.env
or.env.local
file
Building and working with Malak Locally
Malak runs with very minimal hardware requirements by itself. While it
Malak has been tested and developed extensively on macOS but there are extremely high chances it works and compiles correcly on windows. Let us know if it does :)
To run Malak, you need to install a few things. Go, Node.js, bun, Git. We will not go through the installation of these as you can find them on their relative websites.
Step 1: Clone the Malak Repo
Navigate to the newly created malak
directory
This installs the dependencies you need: Postgresql, Redis, Minio, Grafana and Mailhog for local email testing
At the very minimum, you need to create a config.yml
containing the following:
You can find all possible configuration values here
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn’t align with the production version, please update the CLI:
This should go to your
.env
or.env.local
file