# Installation (/docs/core/getting-started/installation)



# Installation [#installation]

This page is for setting up Atlas in **your own docs repo**. If you are working on the Coolify docs, the repo already ships with Atlas configured, so you can skip straight to the [quick start](/docs/core/getting-started/quick-start).

## Before you start [#before-you-start]

You will need:

* **[Bun](https://bun.sh)** installed, since Atlas runs on Bun.
* A **docs repo** to point Atlas at.
* **Git** available on your machine, which Atlas uses for commits, history, and branches.

## Install Atlas [#install-atlas]

From the root of your docs repo, add Atlas as a dev dependency:

```bash
bun add -d @shadowarcanist/atlas-devkit
```

Then add a script to your `package.json` so you can launch it:

```json
{
  "scripts": {
    "dev:atlas": "atlas --root ."
  }
}
```

The `--root .` tells Atlas to work on the current folder, which is your docs repo.

## Configure the workspace [#configure-the-workspace]

Atlas reads an `atlas.json` file from the root of your repo. Create one and paste in this starter config, then edit it to match your repo. Here is the shape, with the values the Coolify docs use:

```json
{
  "name": "Coolify Docs",
  "contentDir": "content/docs",
  "redirectsFile": "nginx/redirects.conf",
  "publicDir": "public",
  "mediaDir": "public/images",
  "templateDir": "templates",
  "previewUrl": "http://localhost:3000",
  "previewCommand": "bun run dev",
  "redirectBasePath": "/docs"
}
```

Every path is relative to the root of your repo. See [the workspace](/docs/core/getting-started/the-workspace) for what each field controls.

## Run Atlas [#run-atlas]

Start it:

```bash
bun run dev:atlas
```

The dashboard is now available at **[http://localhost:4444](http://localhost:4444)**. Open it in your browser (Atlas does not open it for you).

## Next steps [#next-steps]

<Cards>
  <Card title="Understand your workspace" href="/docs/core/getting-started/the-workspace" />

  <Card title="Start editing" href="/docs/core/editing/editor" />
</Cards>