From 343ca8673db5a4187634499bb758826f43e5c363 Mon Sep 17 00:00:00 2001 From: BradHacker Date: Tue, 23 Apr 2024 21:16:34 -0400 Subject: [PATCH] Add auto installer instructions --- docs/getting-started/quick-start.md | 48 ++++++++++++++++++++++++++--- 1 file changed, 44 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index d2c3ddd..82570b0 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -9,11 +9,51 @@ Use the auto-installer to download CBLE and its prerequisites: ```shell -curl -fsSL https://get.cble.io | sh +. <(curl -fsSL https://get.cble.io) ``` +!!! warning "Shell Support" + + 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 +Installing Docker... +# Executing docker install script, commit: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +# ... docker install output ... + +Cloning into 'cble'... +# ... git output ... +Would you like to perform auto-configuration of CBLE? [Y/n] Y +Are you using SSL (requires DNS to be set up)? [Y/n] Y +What is the domain (FQDN) you plan to use (e.g. cble.io): +Would you like to generate random passwords/keys? [Y/n] Y +Default admin account username [cble]: cble +Default admin account first name [CBLE]: CBLE +Default admin account last name [Admin]: Admin + +CBLE has been installed and auto-configured! + +Once ready, start CBLE with: + + cd cble + docker compose -f docker-compose.local.yml build + docker compose -f docker-compose.local.yml up -d + +Then log in with the following credentials: + + Name: CBLE Admin + Username: cble + Password: +``` + +### Manual-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`. @@ -28,16 +68,16 @@ First, edit the `config.local.yaml` file (see ```yaml title="config.local.yaml" # ... server: - hostname: localhost + hostname: # ... - ssl: false + ssl: true # enable this to auto-provision a TLS certificate # ... origins: - https:// # put your FQDN here # ... database: # ... - password: cble # set this to a secure password for the database + password: # set this to a secure password for the database # ... auth: jwt_key: # generate a random value here