Arches Documentation

Introduction

• Overview
  • What is Arches?
  • Who is Arches for?
  • Documentation Overview
  • Contributing To Arches
• Arches Release Process
  • Feature Releases
  • Patch Releases
  • Release Support

Installing

• Requirements/Dependencies
  • System Requirements
  • Software Dependencies
• Installing Core Arches
  • Create a Virtual Environment
  • Install Arches with pip
• Creating a New Arches Project
  • Create a Project
  • Setup the Database
  • Build a Frontend Asset Bundle
  • View the Project in a Browser
  • Configure the Map Settings
  • Load a Package
  • What Next?
  • Common Errors
• Understanding Projects
  • Project Structure
• Understanding Packages
  • Loading a Package
  • Creating a New Package
  • Configuring a Package
  • Updating an Existing Package

Configuring

• Set Resource Display Names
  • Configure a Descriptor Template
  • Types of Descriptors
• Arches System Settings
  • Arches System Settings Interface
  • Maintaining Arches System Settings
  • Changing the Admin Password
• Settings - Beyond the UI
  • Settings Inheritance
  • Password Validators
  • Time Wheel Configuration
  • Configuring Captcha
  • Enabling User Sign-up
  • Using Single Sign-On With an External OAuth Provider

Administering

• Designing the Database
  • Arches Database Theory
  • Arches Designer
  • Graph Designer
• Ontologies in Arches
  • Loading an Ontology
  • Loading a custom ontology
  • Enforcing ontology rules
• Managing Map Layers
  • Different Types of Layers
• Reference Data Manager (RDM)
  • Concept Schemes
• Managing Permissions
  • Managing Users and Groups in Django Admin
  • Resource Model Permissions
  • Resource Instance Permissions
  • Media Permissions
• Two-factor Authentication
  • How Two-factor Authentication Works
  • Enabling Two-factor Authentication in Arches
  • Setting up Two-factor Authentication for User Accounts
• Spatial Views (preview)
  • Spatial Views Model Schema
  • Creating your first spatial view
  • Using the spatial views
  • Example Usage

Using Arches

• Creating and Editing Resources
  • Resource Manager
  • Resource Editor
  • Related Resources
• Deleting Resources
• Searching

Extending Arches

• Creating Extensions
  • Types of Extensions
  • Extension Architecture
  • Managing Extensions
  • Adding JavaScript Dependencies
• Creating New Map Layers
  • MapBox Layers
• Creating HTML Export Templates
  • Template Location
  • Templating Language
  • Resources Context Data
  • Custom Template Filters
  • Basic Template
  • Advanced Template Example

For Developers

• Accessibility
  • Contents
  • Summary
  • Tools Used
  • Key Points
  • Alternative solutions where components cannot be made accessible
  • Additional Points
• Arches and Elasticsearch
  • Installing Elasticsearch
  • Development Configuration
  • Running Elasticsearch
  • Using the Kibana Dashboard
  • Reindexing The Database
  • Using Multiple Nodes
  • Adding a Custom Index
• API
  • General Notes
  • Authentication
  • Ontology Expectations and Requesting JSON-LD
  • Concepts
  • Resources
  • Activity Stream
  • Mobile Projects
  • GeoJSON
• Command Line Reference
  • Installation Commands
  • ElasticSearch Management
  • Import Commands
  • Export Commands
  • Other Data Management Commands
  • Ontology Commands
  • Managing Functions, DataTypes, Widgets, and Card Components
  • Creating Map Layers
  • Other Useful Django Commands
• Creating a Development Environment
  • Setting Everything Up
  • Overwriting Core Arches Content
  • Handling Upgrades
  • Running Tests
• Data Model
  • Resource Model Overview
  • Controllers
  • Graph Definition
  • Ontologies
  • RDM Models
  • Resource Data
  • UI Component Models
• Integrating Arches with ArcGIS
• Localizing Arches
  • Localizing Graph Strings within Arches
  • Setting up Localized Languages for Business Data
  • RDF Imports and Exports
  • CSV Exports and Imports
• Managing and Hosting IIIF Servers
  • Setting Up Cantaloupe
  • Creating IIIF Manifests / Image Services
  • IIIF Viewer / Annotation data
• Migrating Data from v3
  • Exporting Your Data From v3
  • Migrating Your Data
• Resource Import/Export
  • Importing Data
  • Datatype Formats
  • CSV Import
  • Shapefile Import
  • JSON Import
  • Importing Resource Relations
  • SQL Import
  • Exporting Arches Data
• Task Management
  • Dependencies
  • Configuration
  • Adding Tasks to Your Project
  • Running Celery
• Using Arches Offline

Running Arches in Production

• Set DEBUG = False
• Serving Arches with Apache
  • Configure Apache
  • Prepare the Arches Project
• Implementing SSL
  • Obtaining a SSL certificate
  • Configuring the webserver
• Setting up Supervisord for Celery
  • When Do I Need Supervisord and Celery?
  • Supervisor and Celery Installation and Configuration
• Backing up the Database
• Using AWS S3
  • What is AWS S3?
  • Why Use S3 with Arches?
  • Steps to Follow
• Migrating a Local App to AWS EC2
  • Prerequisites