content/deployment/_index.md

++++
+title = "Deployment"
+sort_by = "weight"
+weight = 90
+insert_anchor_links = "right"
++++
+
+This documentation is aimed at **system administrators** and **business leaders** who wish to deploy the Arkindex platform on their own hardware or cloud provider instead of using instances provided by Teklia (like [demo.arkindex.org](https://demo.arkindex.org)).
+
+If you are interested in using Arkindex on your own documents, but **cannot publish them on publicly available instances** (due to privacy or regulatory concerns), it's possible to deploy the full Arkindex platform on your own infrastructure.
+
+We currently offer [two editions of Arkindex](@/overview/license.md):
+1. Community Edition, under the AGPL-v3 open-source license, suitable if your project is also open-source,
+2. Enterprise Edition, suitable for all proprietary projects.
+
+Please [contact us](https://teklia.com/company/contact/) if you are interested in Arkindex for your company or institution. We offer dedicated services for all your arkindex needs (training, setup, project consulting, feature development,...)
+
+
+## Requirements
+
+Arkindex needs a few hard-requirements to run on your own hardware:
+- [Docker](https://docs.docker.com/get-docker/) is needed, as we only deploy through Docker images,
+- Linux servers are the only Operating System support. We heavily recommend using [Ubuntu LTS](https://ubuntu.com/download/desktop)
+- All your images must be hosted on a [IIIF](https://iiif.io/) server, or you'll need to expose them through a local IIIF server
+
+To run the Enterprise Edition, your servers must be able to make regular API calls (a few times a day) on a remote server to validate its licence. The server does **not** necessarily need to be exposed to Internet, but simply be able to make requests towards a domain.
+
+## Content
+
+In this section you'll find out how to:
+
+1. pick an [architecture](@/deployment/architecture.md) that suits your needs
+2. choose your [own hardware](@/deployment/hardware.md) to run Arkindex efficiently that suits your needs
+3. setup [Arkindex](@/deployment/setup.md) in production mode,
+4. configure [Arkindex](@/deployment/configuration.md)

content/deployment/architecture.md

++++
+title = "Architectures"
+sort_by = "weight"
+weight = 30
++++
+
+
+## Architecture
+
+The main part of the architecture uses a set of open-source software along with our own proprietary software.
+
+{{ figure(image="deployment/architecture.png", height=400, caption="Arkindex platform architecture") }}
+
+The open source components here are:
+- Traefik as load balancer,
+- Cantaloupe as IIIF server,
+- Minio as S3-compatible storage server,
+- Redis as cache,
+- PostgreSQL as database,
+- Solr as search engine.
+
+You'll also need to run a set of workers on dedicated servers: this is where the Machine Learning processes will run.
+
+{{ figure(image="deployment/workers.png", height=400, caption="Arkindex workers for Machine Learning") }}
+
+Each worker in the diagram represents a dedicated server, running our in-house job scheduling agents and dedicated Machine Learning tasks.
+

content/howto/on_premise/configuration.md → content/deployment/configuration.md

 +++
-title = "Configure Arkindex backend"
+title = "Settings"
 description = "All the configuration options available to setup your Arkindex backend"
 
-# Clean slug for parent folder
-path = "howto/on-premise/configuration/"
+weight = 30
 +++
 
 You will find on this page all the configuration settings available for the Arkindex backend. These settings must be stored in a YAML file, and exposed using a Docker volume to the backend and worker container. The configuration path  is set through `CONFIG_PATH` environment variable.

content/howto/on_premise/index.md → content/deployment/hardware.md

 +++
-title = "Deploy Arkindex on-premise"
-description = "Deploy Arkindex on your own infrastucture"
-
-weight = 110
-
+title = "Hardware"
+sort_by = "weight"
+weight = 20
 +++
 
-If you are interested in using Arkindex on your own documents, but **cannot publish them on our own instances** (due to privacy or regulatory concerns), it's possible to deploy the full Arkindex platform on your own infrastructure.
-
-In the following sections, we'll describe the requirements needed to run an efficient and scalable Arkindex infrastructure using **Docker containers** on your own hardware. This setup is able to handle millions of documents to process with multiple Machine Learning processes.
-
-## Architecture
-
-The main part of the architecture uses a set of open-source software along with our own proprietary software.
-
-{{ figure(image="howto/on_premise/architecture.png", height=400, caption="Arkindex platform architecture") }}
-
-The open source components here are:
-- Traefik as load balancer,
-- Cantaloupe as IIIF server,
-- Minio as S3-compatible storage server,
-- Redis as cache,
-- PostgreSQL as database,
-- Solr as search engine.
-
-You'll also need to run a set of workers on dedicated servers: this is where the Machine Learning processes will run.
-
-{{ figure(image="howto/on_premise/workers.png", height=400, caption="Arkindex workers for Machine Learning") }}
-
-Each worker in the diagram represents a dedicated server, running our in-house job scheduling agents and dedicated Machine Learning tasks.
-
 ## Hardware
 
 ### Platform
@@ -75,27 +49,3 @@ The requirement of each server depends on the type of your processes and dataset
 
 
 
-## Requirements
-
-- Use Linux servers and Docker. We provide support for the Ubuntu LTS distribution, and only provide Docker images to run our software.
-- Your instance must be able to make regular API calls (once a day) on a remote server to validate its licence. The server does **not** need to be exposed to Internet, but simply be able to make requests towards a domain.
-
-## Deliverables
-
-- Docker images:
-	- backend
-	- agent to run processes
-	- relevant Machine Learning workers used in processes (DLA, HTR, NER, ...)
-	- frontend assets
-- Documentation to deploy and manage an instance using [Ansible playbook](https://www.ansible.com/)
-
-
-## Pricing
-
-Please [contact us](https://teklia.com/company/contact/) if you are interested in this solution for your company or institution.
-
-We can also provide a private instance that we manage on our servers (hosted in Europe or North America).
-
-## Run with docker
-
-More information on [running Arkindex using docker-compose](@/howto/on_premise/docker_compose.md)

content/howto/on_premise/docker_compose.md → content/deployment/setup.md

@@ -2,8 +2,7 @@
 title = "Deploy Arkindex with docker-compose"
 description = "Deploy Arkindex on your own infrastucture using Linux and docker-compose"
 
-# Clean slug for parent folder
-path = "howto/on-premise/docker-compose/"
+weight = 10
 +++
 
 This documentation is written for **system administrators**.
@@ -50,7 +49,7 @@ Teklia will provide you with several docker images (to load using [docker load](
 - the tasks image, `registry.gitlab.teklia.com/arkindex/tasks:X.Y.Z`, will be used to by the remote workers (file imports, thumbnails generation, ...).
 - the ponos image, `registry.gitlab.teklia.com/arkindex/ponos-agent:X.Y.Z` will be used to actually run the asynchronous tasks across all your remote workers.
 - 
-{{ figure(image="howto/on_premise/stack.png", height=250, caption="Arkindex Platform and a single Worker") }}
+{{ figure(image="deployment/stack.png", height=250, caption="Arkindex Platform and a single Worker") }}
 
 The backend image mentioned above will run in two containers on your application server:
 1. for the API, this is really the heart of Arkindex,
@@ -67,7 +66,7 @@ Of course your setup may differ, you could use external services (databases, sea
 
 ### Configuration
 
-All the configuration options for the backend are detailed [on this page](@/howto/on_premise/configuration.md).
+All the configuration options for the backend are detailed [on this page](@/deployment/configuration.md).
 
 A minimal configuration file is also available in the [public repository](https://gitlab.teklia.com/arkindex/public-architecture/-/blob/master/config.yml).