diff --git a/docs/docs/getting-started.mdx b/docs/docs/getting-started.mdx
index 0442965..8dfb14b 100755
--- a/docs/docs/getting-started.mdx
+++ b/docs/docs/getting-started.mdx
@@ -7,15 +7,36 @@ description: Getting started with hyperglass
---
import Tabs from '@theme/Tabs';
+import Link from "@docusaurus/Link";
import TabItem from '@theme/TabItem';
-import Admonition from "react-admonitions"
+import Admonition from "react-admonitions";
+import Code from "../src/components/JSXCode";
-# Download & Install
+
+# Automatic installation
+
+If your system runs on:
+
+- Ubuntu Linux
+- ~~CentOS/Red Had Linux~~
+- macOS (requires [homebrew](https://brew.sh))
+
+You should be able to proceed with the automatic installation:
+
+```bash
+curl https://raw.githubusercontent.com/checktheroads/hyperglass/v1.0.0/install.sh | sudo bash
+```
+
+
+ You should be very worried when someone asks you to do what I just did. Downloading a bash script from the internet and piping it to bash with root privileges is a terrible idea, unless you fully trust the source. Please don't trust me - go look at the code and determine for your self if it's safe to execute. If you feel it's not, please proceed with the manual installation.
+
+
+# Manual Installation
## System Dependencies
### Python
-hyperglass is written in Python 3 and requires Python version 3.6 as a minimum dependency. If your system has a version of Python older than this, you may want to consider using hyperglass in a virtual environment. For development, hyperglass uses the [Poetry](https://python-poetry.org/) dependency and virtual environment tool, so it's probably easiest to use Poetry if you need to use a virtual environment.
+hyperglass is written in Python 3 and requires Python version 3.6 as a minimum dependency.
If you're confident upgrading your system's version of Python won't break your system (many Linux operating systems rely heavily on Python for package management and other system functions), you can install Python 3.6:
@@ -52,7 +73,7 @@ python3 --version
```
### Other Dependencies
-The hyperglass UI is written in [ReactJS](https://reactjs.org/). As such, some Javascript dependencies are required:
+The hyperglass UI is written in [ReactJS](https://reactjs.org/). As such, some Javascript dependencies are required. hyperglass also relies on [Redis](https://redis.io/) for caching purposes.
```bash
-# Add NodeJS
+# Add NodeJS Repository
curl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash -
-# Add Yarn Package Manager
+# Add Yarn Package Manager Repository
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
@@ -80,11 +101,13 @@ sudo apt install -y nodejs yarn redis-server
```bash
-# Add NodeJS
+# Add NodeJS Repository
curl -sL https://rpm.nodesource.com/setup_13.x | sudo bash -
-# Add Yarn Package Manager
+# Add Yarn Package Manager Repository
curl -sL https://dl.yarnpkg.com/rpm/yarn.repo -o /etc/yum.repos.d/yarn.repo
+
+# Install
sudo yum -y install gcc-c++ make nodejs yarn redis
```
@@ -98,7 +121,8 @@ I've attempted to abstract away most of the Javascript-related configuration and
## Application
-
- Attempt to package and distribute via PIP
-
+```bash
+pip3 install hyperglass
+```
+
diff --git a/docs/docs/setup.mdx b/docs/docs/setup.mdx
new file mode 100644
index 0000000..fe69aff
--- /dev/null
+++ b/docs/docs/setup.mdx
@@ -0,0 +1,7 @@
+---
+id: setup
+title: Setup
+sidebar_label: Setup
+keywords: [install, setup]
+description: hyperglass Setup
+---
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index d5bb084..2bfc391 100755
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -2,7 +2,7 @@ const githubURL = "https://github.com/checktheroads/hyperglass";
module.exports = {
title: "hyperglass",
- tagline: "documentation for the modern network looking glass",
+ tagline: "the network looking glass that tries to make the internet better.",
url: "https://hyperglass.io",
baseUrl: "/",
favicon: "img/favicon.ico",
@@ -49,12 +49,12 @@ module.exports = {
title: "Community",
items: [
{
- label: "Stack Overflow",
- href: "https://stackoverflow.com/questions/tagged/docusaurus"
+ label: "Gitter",
+ href: "https://gitter.im/hyperglass"
},
{
- label: "Discord",
- href: "https://discordapp.com/invite/docusaurus"
+ label: "Keybase",
+ href: "https://keybase.io/team/hyperglass"
}
]
},
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 706d98d..5727ef7 100755
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -6,6 +6,7 @@ module.exports = {
items: [
"introduction",
"getting-started",
+ "setup",
"configuration",
"devices",
"ui",
diff --git a/docs/src/pages/index.js b/docs/src/pages/index.js
index 8d090e1..fe08cb8 100755
--- a/docs/src/pages/index.js
+++ b/docs/src/pages/index.js
@@ -58,7 +58,10 @@ function Home() {
const context = useDocusaurusContext();
const { siteConfig = {} } = context;
return (
-
+