Add mdBook skeleton (#640)
This commit is contained in:
parent
cddd215025
commit
e904793b7e
|
@ -0,0 +1 @@
|
|||
book
|
|
@ -0,0 +1,6 @@
|
|||
# Nomos Node Book
|
||||
|
||||
To build the book and view it in your browser, run the following command:
|
||||
```bash
|
||||
mdbook serve --open
|
||||
```
|
|
@ -0,0 +1,6 @@
|
|||
[book]
|
||||
authors = []
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "Nomos Node"
|
|
@ -0,0 +1,7 @@
|
|||
# Summary
|
||||
|
||||
- [Introduction](./introduction.md)
|
||||
- [Installation](./installation/installation.md)
|
||||
- [Docker image](./installation/docker.md)
|
||||
- [Building from source](./installation/source.md)
|
||||
- [Run Nodes](./run-nodes.md)
|
|
@ -0,0 +1,22 @@
|
|||
# Installation using Docker
|
||||
|
||||
## Building the Docker image
|
||||
|
||||
To build the Docker image, run the following command at the root of the project:
|
||||
```bash
|
||||
docker build -t nomos .
|
||||
```
|
||||
|
||||
## Using the Docker image
|
||||
|
||||
You can run a Nomos node using the Docker image by running the following command:
|
||||
```bash
|
||||
docker run nomos /etc/nomos/config.yml
|
||||
```
|
||||
|
||||
To run a node with a different configuration run:
|
||||
```bash
|
||||
docker run -v /path/to/config.yml:/etc/nomos/config.yml nomos /etc/nomos/config.yml
|
||||
```
|
||||
|
||||
For more detailed instructions to configure and run Nomos nodes, refer to the [Run Nodes](../run-nodes.md).
|
|
@ -0,0 +1,7 @@
|
|||
# Installation
|
||||
|
||||
Nomos Node runs on Linux, macOS, and Windows.
|
||||
|
||||
There are several ways to install Nomos Node:
|
||||
- [Docker image](./docker.md)
|
||||
- [Building from source](./source.md)
|
|
@ -0,0 +1 @@
|
|||
# Building from source
|
|
@ -0,0 +1 @@
|
|||
# Nomos Node
|
|
@ -0,0 +1,11 @@
|
|||
# Run Nomos Nodes
|
||||
|
||||
This section provides instructions to configure and run multiple Nomos nodes.
|
||||
You should read with the [Installation](../installation/installation.md) section before proceeding.
|
||||
|
||||
## Configuration
|
||||
|
||||
A Nomos node is configured using a configuration file (YAML).
|
||||
If you are running a node using the Docker image, the config file is contained in the image (`/etc/nomos/config.yml`).
|
||||
|
||||
TODO
|
|
@ -0,0 +1 @@
|
|||
# Run Nodes
|
Loading…
Reference in New Issue