Skip to content

Commit

Permalink
Merge installation pages into single page
Browse files Browse the repository at this point in the history
  • Loading branch information
BradHacker committed Apr 24, 2024
1 parent 683c931 commit 4a04a11
Show file tree
Hide file tree
Showing 10 changed files with 83 additions and 111 deletions.
3 changes: 3 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@ MD013:
line_length: 120
MD033: false
MD046: false # Code block style errors interfere with admonitions
MD007:
indent: 4
MD030: false
5 changes: 4 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,8 @@
},
"editor.wordWrapColumn": 120,
"editor.wordWrap": "wordWrapColumn",
"editor.rulers": [120]
"editor.rulers": [120],
"editor.tabSize": 4,
"editor.indentSize": "tabSize",
"editor.detectIndentation": false
}
8 changes: 4 additions & 4 deletions docs/getting-started/.pages
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nav:
- quick-start.md
- manual-install.md
- providers
- blueprints
- installation.md
- Behind the Scenes:
- providers
- blueprints
- ...
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Quick Start
# Installation

!!! info "Base OS Selection"

This deployment has only been tested on **Fedora 38/39** and **Ubuntu 22.04**

## Install
## Automatic Installation (Recommended)

Use the auto-installer to download CBLE and its prerequisites:

Expand All @@ -16,10 +16,6 @@ Use the auto-installer to download CBLE and its prerequisites:

The auto installer has only been tested with the **zsh** and **bash** shells

## Configure

### Auto-Configuration (Recommended)

Follow the automatic installer prompts to automatically configure CBLE:

```shell
Expand Down Expand Up @@ -52,7 +48,53 @@ Then log in with the following credentials:
Password: <random password>
```

### Manual-Configuration
Now run CBLE with:

```shell
cd cble
docker compose -f docker-compose.local.yml build
docker compose -f docker-compose.local.yml up -d
```

## Manual Installation

### Installation Methods

#### Docker (Recommended)

Install [Docker](https://docker.com) with:

```shell
curl -fsSL https://get.docker.com/ | sh
```

Clone the CBLE repository:

```shell
git clone https://github.com/cble-platform/cble
```

Move into the deploy directory and create local configuration files from the provided examples:

```shell
cd cble
cp config.example.yaml config.local.yaml
cp Caddyfile.example Caddyfile
cp docker-compose.yml docker-compose.local.yml
```

To start CBLE, first build the container images and the run the containers:

```shell
docker compose -f docker-compose.local.yml build
docker compose -f docker-compose.local.yml up -d
```

#### System-wide

Coming soon.

### Configuration

For these next steps you'll need to know the Fully Qualified Domain Name (FQDN) of the deployment. This
would look something like `https://docs.cble.io`.
Expand Down Expand Up @@ -118,19 +160,10 @@ services:
# ...
```

## Deploy

Build the container images locally:
## Login to CBLE

```shell
docker compose -f docker-compose.local.yml build
```
You can now visit the CBLE dashboard at `https://<your fqdn>`. You should be greeted with the login page:

Finally, run CBLE in the background (may take a minute on first boot):

```shell
docker compose -f docker-compose.local.yml up -d
```
![Login Page](./login-fs8.png){ loading=lazy }

You can now visit the CBLE dashboard at `https://<your fqdn>` and log in with the username `cble` and the
secure password you created in `config.local.yaml`.
Log in with the username and password you created during configuration.
76 changes: 0 additions & 76 deletions docs/getting-started/manual-install.md

This file was deleted.

10 changes: 3 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ hide:

---

Use the [auto-installer](./getting-started/quick-start.md#install) to get up and running in minutes
Use the [auto-installer](./getting-started/installation.md#automatic-installation-recommended) to get up and running
in minutes

[:octicons-arrow-right-24: Getting started](./getting-started/quick-start.md)
[:octicons-arrow-right-24: Getting started](./getting-started/installation.md)

- :simple-yaml:{ .lg .middle } __Configure with just YAML__

Expand All @@ -35,11 +36,6 @@ hide:

</div>

<!-- The Cloud-Based Lab Emulator (or __CBLE__ for short) is designed to be a fully-automated self-service virtual lab
environment that is cloud provider agnostic. This means whatever your resources, CBLE can scale to be the solution you need.
[Get Started :material-chevron-right:](./getting-started/quick-start.md){ .md-button .md-button--primary } -->

## Project Inspiration

This project was proposed as an Independent Study at [Rochester Institute of Technology](https://rit.edu) as a part of my
Expand Down
4 changes: 2 additions & 2 deletions docs/references/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

!!! note

All defaults are pulled from the `config.example.yaml` file and only support a local deployment. For production
environments see [Getting Started - Quick Start](../getting-started/quick-start.md).
All defaults are pulled from the `config.example.yaml` file. For instructions on configuring production environments
see [Installation - Configuration](../getting-started/installation.md#configuration).

## Global Options

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ plugins:
- social
- mike:
canonical_version: latest
- glightbox
extra_css:
- stylesheets/extra.css
extra:
Expand Down
13 changes: 12 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ mkdocs-awesome-pages-plugin = "^2.9.2"
pillow = "^10.2.0"
cairosvg = "^2.7.1"
mike = "^2.0.0"
mkdocs-glightbox = "^0.3.7"


[build-system]
Expand Down

0 comments on commit 4a04a11

Please sign in to comment.