Skip to content

Commit

Permalink
docs: add quickstart guide (#262)
Browse files Browse the repository at this point in the history
  • Loading branch information
scarmuega authored May 28, 2024
1 parent c789a37 commit ce69556
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/components/hero.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ export function Hero() {
<div className="flex justify-center">
<a
className="bg-gradient-to-tl from-emerald-600 to-cyan-600 border border-transparent text-white text-sm rounded-md focus:outline-none focus:ring-2 focus:ring-blue-600 focus:ring-offset-2 focus:ring-offset-white py-3 px-4 dark:focus:ring-offset-gray-800"
href="/introduction"
href="/quickstart"
>
Documentation
Quickstart
</a>
</div>
</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
"layout": "full"
}
},
"introduction": "Introduction",
"quickstart": "Quickstart",
"installation": "Installation",
"configuration": "Configuration",
"bootstrap": "Bootstrap",
"running": "Running",
"apis": "APIs"
"apis": "APIs",
"advanced": "Advanced"
}
File renamed without changes.
83 changes: 83 additions & 0 deletions docs/pages/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
import { Steps, Tabs, Tab, Cards, Card } from "nextra/components"

# Quickstart

In this guide we're going to learn how to go from zero to a running Dolos instance with the least amount of effort.

<Steps>
### Installation

<Tabs items={['mac', 'linux', 'windows', 'docker']}>
<Tabs.Tab>
You can use Homebrew to install the latest version of Dolos in Mac (both x86 / ARM64)

```sh
brew install txpipe/tap/dolos
```
</Tabs.Tab>
<Tabs.Tab>
You can install Dolos on linux system using the following command:

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/txpipe/dolos/releases/latest/download/dolos-installer.sh | sh
```
</Tabs.Tab>
<Tabs.Tab>
You can use Powershell to install Dolos on Windows systems:

```sh
powershell -c "irm https://github.com/txpipe/dolos/releases/latest/download/dolos-installer.ps1 | iex"
```
</Tabs.Tab>
<Tabs.Tab>
_Dolos_ provides public Docker images through Github Packages. To execute _Dolos_ via Docker, use the following command:

```sh
docker run ghcr.io/txpipe/dolos:latest
```
</Tabs.Tab>
</Tabs>

For more detailed information on how to install Dolos, check the [installation section](./installation)

### Configuration

To configure _Dolos_, run the following command that will guide you through a set of questions to automatically configure your instance:

```sh
dolos init
```

For more detailed information on how to configure Dolos, check the [configuration section](./configuration)

### Bootstrap

To bootstrap _Dolos_ (aka: sync the history of the chain), run the following command to import a Mithril snapshot:

```sh
dolos bootstrap
```

For more detailed information on how to bootstrap Dolos, check the [bootstrap section](./bootstrap)

### Running

Run the following command to start Dolos in `daemon` mode. This will keep runnig forever while syncing the chain from the upstream node and serving data through the APIs.

```sh
dolos daemon
```

For more detailed information on different ways to run _Dolos_, check the [running section](./bootstrap)

{/*
### That's it!
You should now have a working Dolos instance. So, what's next?
<Cards>
<Card title="Discover APIs" href="aa"/>
<Card title="Discover Middleware" href="aa"/>
</Cards>
*/}
</Steps>

0 comments on commit ce69556

Please sign in to comment.