Skip to content

Commit

Permalink
Docs: Add manual installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
MacroPower committed Oct 5, 2020
1 parent 12fcda2 commit 8f7811b
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,41 @@
# Getting Started

OmegaGraf has a few dependencies that must be installed prior to use.

## Compatibility

**OmegaGraf is supported on Windows and all major Linux distributions.** Our testing is done using Ubuntu, so that will probably be the best experience.
**OmegaGraf is supported on Windows and all major Linux distributions.** Our testing is done using Ubuntu, so using that will probably result in the best / most bug-free experience.

\* _We do not currently support MacOS, but if you're up for working with the C# Docker package on MacOS, feel free to give it a try!_

## Installation

OmegaGraf has interactive [installers](https://github.com/MacroPower/OmegaGraf/tree/master/install) that can assist with installation.
OmegaGraf has a few dependencies that must be installed prior to use.

OmegaGraf has interactive [installers](https://github.com/MacroPower/OmegaGraf/tree/master/install) that can assist with installation. The installers page details prerequisites, and how to run the script.

Alternatively, you can do the following:

- Install `apt-transport-https ca-certificates gnupg2 software-properties-common`
- Install `docker-ce`. Click for instructions:
[Debian](https://docs.docker.com/engine/install/debian/),
[Ubuntu](https://docs.docker.com/engine/install/ubuntu/),
[CentOS](https://docs.docker.com/engine/install/centos/), or
[Fedora](https://docs.docker.com/engine/install/fedora/).
- Add the user that will be running OmegaGraf, e.g. `$USER`, to the docker group.
- (Optional) Generate an SSL cert
- Install `dotnet-sdk-3.1`. Click for instructions:
[Debian](https://docs.microsoft.com/en-us/dotnet/core/install/linux-debian),
[Ubuntu](https://docs.microsoft.com/en-us/dotnet/core/install/linux-ubuntu),
[CentOS](https://docs.microsoft.com/en-us/dotnet/core/install/linux-centos), or
[Fedora](https://docs.microsoft.com/en-us/dotnet/core/install/linux-fedora).
- Run `dotnet dev-certs https`.
- When you run OmegaGraf, use an `https` listening address.
- Download an OmegaGraf binary from [releases](https://github.com/MacroPower/OmegaGraf/releases).
- Ensure you have execute permissions on the binary.
- See [Using OmegaGraf](#using-omegagraf) for next steps.

## Using OmegaGraf

The installer will print an example start command. For more help on usage, see the [walkthrough](walkthrough.md).
The installer will print an example start command, e.g. `./OmegaGraf --host http://0.0.0.0:5000`, which you can use to launch OmegaGraf. For more help on usage, see the [walkthrough](walkthrough.md).

Note: **OmegaGraf currently uses the current _working directory_ to store container data.** Please keep this in mind. If you want to change this behavior, you can supply the `--path` argument along with an absolute or relative path to store data.

Expand Down

0 comments on commit 8f7811b

Please sign in to comment.