diff --git a/content/deployment/_index.md b/content/deployment/_index.md index f284e2d49cd921d8826dbf40a05888ceaa22948d..c04cceb7ac2a385b474361f58b9b1aab66e41c9a 100644 --- a/content/deployment/_index.md +++ b/content/deployment/_index.md @@ -5,25 +5,31 @@ weight = 90 insert_anchor_links = "right" +++ -This documentation is aimed at system administrators and business leaders who want to deploy the Arkindex platform on their own hardware. +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 our own instances** (due to privacy or regulatory concerns), it's possible to deploy the full Arkindex platform on your own infrastructure. +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. -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. +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,...) -In this section you'll find out how to: - -1. setup [Arkindex](@/deployment/setup.md), in production mode, +## Requirements -## Pricing +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 -Please [contact us](https://teklia.com/company/contact/) if you are interested in this solution for your company or institution. +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. -We can also provide a private instance that we manage on our servers (hosted in Europe or North America). +## Content -## Requirements +In this section you'll find out how to: -- 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. +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)