Skip to content

Commit

Permalink
docs(web): add quickstart instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
justmoon committed Nov 6, 2023
1 parent 95e37a4 commit be1f76a
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 6 deletions.
9 changes: 4 additions & 5 deletions packages/app-website/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Dassie
# What is Dassie?

A peer-to-peer network which can transfer tiny amounts of money quickly and cheaply.

It's not a blockchain - payments are routed like packets through the network and are not stored.
It's not a blockchain - payments are routed like packets through the network and are not stored. The only shared state is the link state used for routing.

## Why Dassie?

### Scalable

Dassie can handle very large amounts of very small payments and scales horizontally meaning its capacity increases as more nodes join the network.
Dassie can handle very large amounts of very small payments and scales horizontally meaning its throughput capacity increases as more nodes join the network.

### Currency-neutral

Expand All @@ -20,5 +20,4 @@ The current implementation uses various cryptocurrencies as the underlying value

## Status

The Dassie project is the very early stages of development. The first version of the software is expected to be released in the next few months.

The Dassie project is the very early stages of development. The current version is a preview release which only supports test payments (without real-world value) and does not yet supported currency conversion.
61 changes: 60 additions & 1 deletion packages/app-website/pages/quick-start.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,62 @@
# Quick Start

Coming soon!
So you want to try out Dassie. First, let me congratulate you on your bravery. Second, let me warn you that Dassie is still in the early stages of development and is not yet ready for production use. If you're still interested, read on.

## Prerequisites

You will need a server (or virtual machine) with the following:

* Linux
* Must be a recent distribution (we did all our testing on Debian Bullseye)
* Must use systemd
* Curl
* A publicly accessible IP address
* A domain name that points to that IP address
* TCP ports 80 and 443 open to the world

## Installation

To install Dassie, run the following command on your server:

```sh
curl --tlsv1.2 -sSf https://sh.dassie.land | sh
```

This will download and run the Dassie installer script. The script install Dassie on your server.

If you are running as a non-root user you will need to close your SSH session and log in again at this point. This is because the installer script adds your user to the `dassie-users` group, and group membership changes only take effect the next time you log in.

## Configuration

Before we can access Dassie's snazzy web interface, we need to set you up with a TLS certificate. Fortunately, Dassie has Let's Encrypt integration built in, so it should be a quick and easy process.

Just run the initialization command:

```sh
dassie init
```

Once you have successfully set up your TLS certificate, the dassie init command will print out a URL where you can continue the setup process. If you miss the URL the first time, you can run `dassie init` again or you can find it in the Dassie logs:

```sh
journalctl -xeu dassie
```

## Updating Dassie

Dassie comes with an auto-updater which is enabled by default. So you should not have to worry about updating Dassie.

To manually trigger an update, run the following command on your server:

```sh
sudo dassie update
```


## Deinstallation

If you ever need to uninstall Dassie, you can run the following command on your server:

```sh
curl --tlsv1.2 -sSf https://sh.dassie.land | sh -s -- uninstall
```

1 comment on commit be1f76a

@vercel
Copy link

@vercel vercel bot commented on be1f76a Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.