3wordchant/oasis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
64154f2eed
oasis/docs/install.md
Christian Bundy 64154f2eed Change to organize install docs
2020-01-03 15:04:16 -08:00

1.1 KiB
Raw Blame History

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.

If you want to run Oasis in a container, see with-docker.md.

Download

HTTPS

Most people should download Oasis over HTTPS.

git clone https://github.com/fraction/oasis.git

SSH

If you already have SSH, you may prefer to download over SSH instead.

git clone git@github.com:fraction/oasis.git

Install

Most people should build and install Oasis with npm.

cd oasis
npm install
npm --global install .

Start

You did it! Oasis should now be installed.

oasis --help

If you have problems, read the documentation on downloading and installing packages globally or get some help.