Download and Install NodeJS >= 18.15.0
-
Install kozmo
npm install -g kozmo
-
Start kozmo
npx kozmo start
With username & password
npx kozmo start --KOZMO_USERNAME=user --KOZMO_PASSWORD=1234
- Go to
docker
folder at the root of the project - Copy
.env.example
file, paste it into the same location, and rename to.env
docker-compose up -d
- Open http://localhost:3000
- You can bring the containers down by
docker-compose stop
-
Build the image locally:
docker build --no-cache -t kozmo .
-
Run image:
docker run -d --name kozmo -p 3000:3000 kozmo
-
Stop image:
docker stop kozmo
Kozmo has 3 different modules in a single mono repository.
-
server
: Node backend to serve API logics -
ui
: React frontend -
components
: Third-party nodes integrations
- Install PNPM
npm i -g pnpm
-
Clone the repository
git clone https://github.com/kozmoai/kozmo.git
-
Go into repository folder
cd kozmo
-
Install all dependencies of all modules:
pnpm install
-
Build all the code:
pnpm build
-
Start the app:
pnpm start
You can now access the app on http://localhost:3000
-
For development build:
-
Create
.env
file and specify theVITE_PORT
(refer to.env.example
) inpackages/ui
-
Create
.env
file and specify thePORT
(refer to.env.example
) inpackages/server
-
Run
pnpm dev
Any code changes will reload the app automatically on http://localhost:8080
-
To enable app level authentication, add KOZMO_USERNAME
and KOZMO_PASSWORD
to the .env
file in packages/server
:
KOZMO_USERNAME=user
KOZMO_PASSWORD=1234
Kozmo support different environment variables to configure your instance. You can specify the following variables in the .env
file inside packages/server
folder. Read more
Deploy kozmo self-hosted in your existing infrastructure, we support various deployments
Coming soon