Skip to content

Commit

Permalink
docs: VM requirements for docker install
Browse files Browse the repository at this point in the history
  • Loading branch information
danh91 committed Jul 29, 2024
1 parent 3cbaedb commit 627be3d
Showing 1 changed file with 23 additions and 16 deletions.
39 changes: 23 additions & 16 deletions apps/www/docs/product/local-development.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ With the ability to self-host karrio, it is easier than ever to setup your shipp
This guide will walk you through the steps to setup karrio for local development.

<VideoWrapper>
<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/SPKYZJn8AGo"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/SPKYZJn8AGo"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
</VideoWrapper>

## Prerequisites

- [Docker](https://docs.docker.com/engine/install/)
- [Docker](https://docs.docker.com/engine/install/)

## Initialize your project

Expand Down Expand Up @@ -58,17 +58,25 @@ curl https://raw.githubusercontent.com/karrioapi/karrio/HEAD/docker/.env -o .env
If you are deploying on a cloud virtual environment (e.g: AWS EC2 or Digital Ocean droplet),
you need to update `KARRIO_PUBLIC_URL` in the `.env` file to your server's `IP address` instead of `localhost`.

````diff
```diff

...
- KARRIO_PUBLIC_URL=http://localhost:5002
+ KARRIO_PUBLIC_URL=http://[YOUR-VM-IP-ADDRESS]:5002
...

````
```

:::
```diff

...
- DASHBOARD_URL=http://localhost:3000
+ DASHBOARD_URL=http://[YOUR-VM-IP-ADDRESS]:3000
...

```

:::

## Start karrio services

Expand Down Expand Up @@ -212,12 +220,11 @@ karrio.worker karrio.docker.scarf.sh/karrio/server:2023.4.2
</details>
:::

- The server should be be accessible at http://localhost:5002
- And the dashboard accessible at http://localhost:3000
- The server should be be accessible at http://localhost:5002
- And the dashboard accessible at http://localhost:3000

By default your login credentials will be: `[email protected]` | `demo`


**You can stop karrio with:**

```bash title="Terminal"
Expand Down

0 comments on commit 627be3d

Please sign in to comment.