Skip to content
Snippets Groups Projects

Document Docker deployment for partners

Merged Document Docker deployment for partners
docker-setup-partners into master
Merged Bastien Abadie requested to merge docker-setup-partners into master
Viewing commit 71aacd5b
Prev Next
Show latest version
2 files
+ 24
− 24
Compare changes
  • Side-by-side
  • Inline
Files
2
  • 71aacd5b
    Erwan Rouchet
    Follow docs style guide · 71aacd5b
    Erwan Rouchet authored 
    - Periods at the end of list items with sentences
- Nothing at the end of short list items
- No "simply", "just", that could offend users
- Split sentences instead of using semicolons
content/deployment/_index.md
+ 14
− 14
@@ -10,7 +10,7 @@ This documentation is aimed at **system administrators** and **business leaders*
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,
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, ...)
@@ -18,24 +18,24 @@ Please [contact us](https://teklia.com/company/contact/) if you are interested i
## 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
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 we 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.
- A domain name for the platform server:
- ideally this is a public domain name if your server is reachable on Internet (like `arkindex.company.com`),
- or an internal domain name, provided by your company's system administrator.
- Ideally, a public domain name if your server is reachable on Internet (like `arkindex.company.com`).
- or an internal domain name, provided by your company's system administrator.
- An SSL certificate for that domain name:
- it can be provided by [Let's Encrypt](https://letsencrypt.org/) freely and automatically if your server is reachable on Internet
- otherwise an internal certificate , provided by your company's system administrator.
- it can be provided by [Let's Encrypt](https://letsencrypt.org/) freely and automatically if your server is reachable on Internet
- or an internal certificate, provided by your company's system administrator.
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.
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 the Internet, but only to 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)
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).