From ce69556fe4e34d3330b356ba8ef0a8a1fb61c6a0 Mon Sep 17 00:00:00 2001 From: Santiago Carmuega Date: Tue, 28 May 2024 17:56:20 -0300 Subject: [PATCH] docs: add quickstart guide (#262) --- docs/components/hero.jsx | 4 +- docs/pages/_meta.json | 5 +- docs/pages/{ => advanced}/introduction.mdx | 0 docs/pages/quickstart.mdx | 83 ++++++++++++++++++++++ 4 files changed, 88 insertions(+), 4 deletions(-) rename docs/pages/{ => advanced}/introduction.mdx (100%) create mode 100644 docs/pages/quickstart.mdx diff --git a/docs/components/hero.jsx b/docs/components/hero.jsx index 33779363..e64b70a2 100644 --- a/docs/components/hero.jsx +++ b/docs/components/hero.jsx @@ -19,9 +19,9 @@ export function Hero() {
- Documentation + Quickstart
diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json index 3003670a..1da1c292 100644 --- a/docs/pages/_meta.json +++ b/docs/pages/_meta.json @@ -7,10 +7,11 @@ "layout": "full" } }, - "introduction": "Introduction", + "quickstart": "Quickstart", "installation": "Installation", "configuration": "Configuration", "bootstrap": "Bootstrap", "running": "Running", - "apis": "APIs" + "apis": "APIs", + "advanced": "Advanced" } diff --git a/docs/pages/introduction.mdx b/docs/pages/advanced/introduction.mdx similarity index 100% rename from docs/pages/introduction.mdx rename to docs/pages/advanced/introduction.mdx diff --git a/docs/pages/quickstart.mdx b/docs/pages/quickstart.mdx new file mode 100644 index 00000000..2aa7460f --- /dev/null +++ b/docs/pages/quickstart.mdx @@ -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. + + +### Installation + + + + You can use Homebrew to install the latest version of Dolos in Mac (both x86 / ARM64) + + ```sh + brew install txpipe/tap/dolos + ``` + + + 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 + ``` + + + 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" + ``` + + + _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 + ``` + + + +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? + + + + + + */} +