Change to organize install docs

This commit is contained in:
Christian Bundy 2020-01-03 15:04:16 -08:00
parent 6e3aed336c
commit 64154f2eed
6 changed files with 88 additions and 25 deletions

View File

@ -27,6 +27,7 @@
"ssbc",
"summerfruit",
"unfollow",
"unikitty"
"unikitty",
"systemd"
]
}

View File

@ -3,7 +3,7 @@
**Friendly Scuttlebutt interface designed for simplicity and accessibility.**
This is an experimental client built with HTML, CSS, and Node.js without any
front-end JavaScript. The goal is to support basic social messaging schemas with
some extra tools for debugging, *not* to support all known message types.
some extra tools for debugging, _not_ to support all known message types.
## Usage
@ -22,33 +22,13 @@ Options:
## Installation
With [npm](https://npmjs.org/):
Most people should install Oasis with [npm](https://npmjs.org/).
```shell
npm -g install @fraction/oasis@latest
npm --global install @fraction/oasis@latest
```
With [yarn](https://yarnpkg.com/en/):
```shell
yarn global add @fraction/oasis@latest
```
With [docker](https://www.docker.com/)
```shell
docker build . -t oasis
docker volume create ssb
docker run --mount source=ssb,target=/root/.ssb -p 3000:3000 --rm oasis
```
### Starting on login
This will install an oasis service for the current user.
```shell
bash contrib/install-systemd-service.bash
```
Want more? Check out [`install.md`](https://github.com/fraction/oasis/blob/master/docs/install.md).
## Resources

50
docs/install.md Normal file
View File

@ -0,0 +1,50 @@
# Install
This is a guide on how to download the source code for Oasis so that you can
build and install it on your computer. If you'd like an easier installation
option, try one of the options in the readme.
If you want to run Oasis in the background, see [`with-systemd.md`](./with-systemd.md).
If you want to run Oasis in a container, see [`with-docker.md`](./with-docker.md).
## Download
### HTTPS
Most people should download Oasis over HTTPS.
```shell
git clone https://github.com/fraction/oasis.git
```
### SSH
If you already have SSH, you may prefer to download over SSH instead.
```shell
git clone git@github.com:fraction/oasis.git
```
## Install
Most people should build and install Oasis with npm.
```shell
cd oasis
npm install
npm --global install .
```
## Start
You did it! Oasis should now be installed.
```shell
oasis --help
```
If you have problems, read the documentation on [downloading and installing
packages globally](https://docs.npmjs.com/downloading-and-installing-packages-globally)
or [get some help](https://github.com/fraction/oasis/issues/new/choose).

18
docs/with-docker.md Normal file
View File

@ -0,0 +1,18 @@
# With Docker
**Warning:** Experimental.
Use [Docker](https://www.docker.com/) to run Oasis in a container.
## Build
```shell
docker build --tag oasis --file contrib/Dockerfile .
docker volume create ssb
```
## Run
```
docker run --mount source=ssb,target=/root/.ssb --publish 3000:3000 --rm oasis
```

14
docs/with-systemd.md Normal file
View File

@ -0,0 +1,14 @@
## With systemd
**Warning:** Experimental.
If you're using Linux and your distribution supports
[systemd](https://systemd.io/), you may be able to have Oasis automatically
start in the background when you start your computer. This is good for SSB and
makes it more likely that you'll download messages that you want.
```shell
bash contrib/install-systemd-service.bash
```
Follow the instructions to finish configuring the background service.