From 8f436eeb333de0f175b86c798acdd26f795eb82d Mon Sep 17 00:00:00 2001 From: Danny van Kooten Date: Mon, 3 Dec 2018 09:15:15 +0100 Subject: [PATCH] get rid of references to latest-development. #191 --- docs/Installation instructions.md | 15 +++++++++++---- docs/Updating to the latest version.md | 5 ++--- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/Installation instructions.md b/docs/Installation instructions.md index 4051e8f1..cbcb910b 100644 --- a/docs/Installation instructions.md +++ b/docs/Installation instructions.md @@ -1,12 +1,15 @@ # Installation instructions for Fathom -To install Fathom on your server, start by [downloading an official binary distribution from the releases page](https://github.com/usefathom/fathom/releases) and place it in `/usr/local/bin`. +To install Fathom on your server: + +1. [Download the latest Fathom release](https://github.com/usefathom/fathom/releases) suitable for your platform. +2. Extract the archive to `/usr/local/bin` ```sh -wget https://github.com/usefathom/fathom/releases/download/latest-development/fathom-linux-amd64 -mv fathom-linux-amd64 /usr/local/bin/fathom +tar -C /usr/local/bin -xzf fathom_$VERSION_$OS_$ARCH.tar.gz chmod +x /usr/local/bin/fathom ``` + Confirm that Fathom is installed properly by running `fathom --version` ```sh @@ -14,7 +17,9 @@ $ fathom --version Fathom version 1.0.0 ``` -## Starting the Fathom web server +## Configuring Fathom + +> This step is optional. By default, Fathom will use a SQLite database file in the current working directory. To run the Fathom web server we will need to [configure Fathom](Configuration.md) so that it can connect with your database of choice. @@ -42,6 +47,8 @@ Check out the [configuration file documentation](Configuration.md) for all possi ## Register your admin user +> This step is optional. If you don't register any users, your Fathom dashboard will be public. + To register a user in the Fathom instance we just created, run the following command from the directory where your `.env` file is. ``` diff --git a/docs/Updating to the latest version.md b/docs/Updating to the latest version.md index acf284af..eca3f1b7 100644 --- a/docs/Updating to the latest version.md +++ b/docs/Updating to the latest version.md @@ -6,11 +6,10 @@ To update your existing Fathom installation to the latest version, first rename mv /usr/local/bin/fathom /usr/local/bin/fathom-old ``` -Then, [download the latest release suitable for your system architecture from the releases page](https://github.com/usefathom/fathom/releases) and place it in `/usr/local/bin`. +Then, [download the latest release archive suitable for your system architecture from the releases page](https://github.com/usefathom/fathom/releases/latest) and place it in `/usr/local/bin`. ``` -wget https://github.com/usefathom/fathom/releases/download/latest-development/fathom-linux-amd64 -mv fathom-linux-amd64 /usr/local/bin/fathom +tar -C /usr/local/bin -xzf fathom_$VERSION_$OS_$ARCH.tar.gz chmod +x /usr/local/bin/fathom ```