Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ We follow the [First Timers Only](https://www.firsttimersonly.com/) philosophy o
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) [![Build Docker images](https://github.com/chaoss/augur/actions/workflows/build_docker.yml/badge.svg)](https://github.com/chaoss/augur/actions/workflows/build_docker.yml) [![Hits-of-Code](https://hitsofcode.com/github/chaoss/augur?branch=release)](https://hitsofcode.com/github/chaoss/augur/view?branch=release) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2788/badge)](https://bestpractices.coreinfrastructure.org/projects/2788)

## NEW RELEASE ALERT!
**If you want to jump right in, the updated docker, docker-compose and bare metal installation instructions are available [here](docs/new-install.md)**.
**Want to get started quickly?** Start with [Docker](https://oss-augur.readthedocs.io/en/main/getting-started/toc.html) for the fastest setup. For production deployments or development, see the [installation guide](docs/new-install.md).

Augur is now releasing a dramatically improved new version. It is also available [here](https://github.com/chaoss/augur/releases/tag/v0.91.0).

Expand Down
8 changes: 4 additions & 4 deletions docs/source/docker/toc.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Docker
=====================
Docker & Advanced Deployment
============================

While Docker is recommended for getting started quickly (see :doc:`Getting Started <../getting-started/toc>`), this section covers advanced Docker deployment scenarios, production configurations, and container management.

.. toctree::
:maxdepth: 1

quick-start
getting-started
docker
docker-compose
usage
27 changes: 13 additions & 14 deletions docs/source/getting-started/toc.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
==================
===============
Getting Started
==================
===============

This section of the documentation is a no work experience required walkthrough of the Augur project. By the end, youll hopefully have a fully functioning local installation of Augur ready to collect data.
This section of the documentation is a no work experience required walkthrough of the Augur project. By the end, you'll hopefully have a fully functioning local installation of Augur ready to collect data.

If you want to get started as fast as possible, we have `Docker images <../docker/toc.html>`_; however, if you’re looking to use Augur for long-term data collection or if you want to install it for development, you’ll need to follow this walkthrough.
Choose Your Installation Method
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Augur offers two primary installation approaches:

.. note::

We currently officially support the local installation of Augur from source on macOS, Ubuntu, and Fedora (but most UNIX-like systems will probably work with a few tweaks). We recommend either using the Docker images or setting up a virtual machine with a supported operating system installed if you are using Windows.
**Docker (Recommended for Quickstart)**: The fastest way to get Augur up and running with minimal setup. Viable for installations of any size.

To install from source, we'll need to do a few things:
**Manual Installation**: For deployments requiring direct system access, development work, or specific customization needs. Both Docker and manual installation are suitable for long-term use—they represent different management styles. We officially support macOS, Ubuntu, and Fedora for manual installation.

1. Setup a PostgreSQL instance to store the data collected by Augur
2. Install and configure Augur's application server
3. Install and configure Augur's data collection workers
.. note::

The next section will start with a database setup, and then you can continue with the following steps given below.
On Windows, Docker installs run in a virtual machine behind the scenes because containers rely on features of the Linux kernel. Manual installation on Windows requires setting up a virtual machine with a supported operating system.

Happy hacking!
Select the installation method below to get started:

.. toctree::
:maxdepth: 1

database
using-docker
installation
database
collecting-data
frontend
command-line-interface/toc
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Augur Documentation

getting-started/Welcome
quick-start
deployment/toc
getting-started/toc
deployment/toc
development-guide/toc
rest-api/api
docker/toc
Expand Down
10 changes: 8 additions & 2 deletions docs/source/quick-start.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
Quickstart
===============

Select installation instructions from those most closely related to the operating system that you use below. Note that Augur's dependencies do not consistently support python 3.11 at this time. Python 3.8 - Python 3.10 have been tested on each platform.
Get Augur running in minutes! We offer two straightforward paths:

**Docker Quickstart (Fastest)** - Get started in minutes with Docker or Podman. Requires ~10 GB RAM, 8 CPUs, and 100 GB disk.

**Manual Installation** - For production deployments, development work, or if Docker isn't available on your platform.

Note: We support all officially supported versions of Python. Although some features may not work on brand new Python versions as soon as they release, we currently test on Python 3.10 and 3.11.

.. toctree::
:maxdepth: 2

getting-started/using-docker
getting-started/new-install
getting-started/dev-osx-install
getting-started/using-docker


Explanations of Technologies
Expand Down
Loading