• Introduction

  • Installation and Configuration

    #rename Installing

  • Configuring

    #new

  • Administering

    #new

  • Using Arches

  • Using Arches Collector

  • Developing with Arches

  • Running Arches in Production

    #new #11

  • References

  • Overview

  • Arches Release Process

  • Requirements/Dependencies

  • Installing Arches

  • Configuring Settings

  • Projects and Packages

  • Task Management

  • Designing the Database

  • Ontologies in Arches

  • Creating Resources

  • Deleting Resources

    #new

  • Searching

    #new also see in-app help

  • Managing Map Layers

  • Reference Data Manager (RDM)

  • Arches Collector Manager

  • Introduction to Arches Collector

  • Arches Collector Workflow

  • Additional Configuration

  • Arches and Elasticsearch

  • API

  • Command Line Reference

  • Creating a Development Environment

  • Creating New Functions, Widgets, Card Components, DataTypes, and Plugins

  • Creating New Map Layers

  • Creating Reports

    #new #205

  • Data Model

  • Localization

    #new #208

  • Migrating Data from v3 to v4

  • Resource Import/Export

  • Settings - Beyond the UI

  • Appendix A: Arches HIP

    #move to the readme file of this repo: https://github.com/archesproject/arches-example-pkg

  • Appendix B: Glossary

  • Appendix C: Serving Arches with Apache

  • Appendix D: Setting Up Supervisord For Celery

  • Appendix E: Managing and Hosting IIIF Servers

  • What is Arches?

    Who is Arches for?

    Documentation Overview

    Contributing To Arches


  • System Requirements

    Software Dependencies

  • Installation

  • Quick Start

    Arches Production Deployment

  • Projects

    Packages

  • Dependencies

    Configuration

    Adding Tasks to Your Project

    Running Celery

  • Arches Database Theory

    Arches Designer

    Graph Designer

  • Loading an Ontology

    Loading a custom ontology

    Enforcing ontology rules

  • Resource Manager

    Resource Editor

  • Different Types of Layers

  • Concept Schemes

  • What Are Arches Collector Projects?

    Arches Collector Manager Overview

    Creating Projects in the Arches Collector Manager

    Creating an Offline Basemap

  • General App Navigation

  • Connect to an Arches Instance

    Download a Project

    Creating Records

    Editing Records

    Syncing Data

  • Password Validators

  • Installing and Running Elasticsearch

    Reindexing The Database

    Using Multiple Nodes

    Adding a Custom Index

  • General Notes

    Authentication

    #move Registering an application to Configuring #114

    Concepts

    Resources

    Activity Stream

    Mobile Projects

    GeoJSON

  • 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

  • Setting Everything Up

  • Functions

    Widgets

    DataTypes

    Card Components

    Plugins

  • MapBox Layers

  • Resource Model Overview

    Controllers

    Graph Definition

    Ontologies

    RDM Models

    Resource Data

    UI Component Models

    Data Model Graph Visualization

  • Exporting Your Data From v3

    Migrating Your Data

  • Importing Data

    Importing a CSV

    Shapefile Import

    JSON Import

    Importing Resource Relations

    Exporting Arches Data

  • Resource Models

    Branches

  • Glossary

  • Setup Apache

    Handling Static Files

                    {"cards":[{"_id":"5f35a26e27e746044eeb0874","treeId":"5f35a26e27e746044eeb0868","seq":21559375,"position":2,"parentId":null,"content":"# Introduction"},{"_id":"47e77b20f878e7d757000011","treeId":"5f35a26e27e746044eeb0868","seq":21559376,"position":1,"parentId":"5f35a26e27e746044eeb0874","content":"## Overview\n \n\n"},{"_id":"47e77a5ef878e7d757000012","treeId":"5f35a26e27e746044eeb0868","seq":21560334,"position":1,"parentId":"47e77b20f878e7d757000011","content":"### What is Arches?\n### Who is Arches for?\n### Documentation Overview\n### Contributing To Arches\n\n---\n\n[ ] Needs a once-over from GCI, and \"Version History\" \n[ ] Could add a link to the Glossary on the archesproject website?\n"},{"_id":"47e779d0f878e7d757000013","treeId":"5f35a26e27e746044eeb0868","seq":21559425,"position":2,"parentId":"5f35a26e27e746044eeb0874","content":"## Arches Release Process"},{"_id":"47e7793ff878e7d757000014","treeId":"5f35a26e27e746044eeb0868","seq":21560338,"position":1,"parentId":"47e779d0f878e7d757000013","content":"### Feature Releases\n### Patch Releases\n### Release Support\n\n---\n\n[ ] Release Support section needs update, and perhaps could be merged with \"Version History\" in above section? (Dennis/Annabel?)\n[ ] Also, consider this page: https://github.com/archesproject/arches/wiki/v4-General-Development-Timeline. Remove it??"},{"_id":"47e7781af878e7d757000015","treeId":"5f35a26e27e746044eeb0868","seq":21592492,"position":3,"parentId":null,"content":"# Installation and Configuration\n#rename **Installing**"},{"_id":"47e77791f878e7d757000016","treeId":"5f35a26e27e746044eeb0868","seq":21560263,"position":1,"parentId":"47e7781af878e7d757000015","content":"## Requirements/Dependencies"},{"_id":"47e77733f878e7d757000017","treeId":"5f35a26e27e746044eeb0868","seq":21560339,"position":1,"parentId":"47e77791f878e7d757000016","content":"### System Requirements\n### Software Dependencies\n- [ ] #new add celery broker section from Task Management (with \"if you plan to...\" just like the Arches Collector/couchdb note. also fix broken link #201\n- [ ] #new add installing pip on Ubuntu #166"},{"_id":"47e7765df878e7d757000018","treeId":"5f35a26e27e746044eeb0868","seq":21560264,"position":2,"parentId":"47e7781af878e7d757000015","content":"## Installing Arches"},{"_id":"47e775fdf878e7d757000019","treeId":"5f35a26e27e746044eeb0868","seq":21560257,"position":1,"parentId":"47e7765df878e7d757000018","content":"### Installation\n- [ ] #new Yarn permissions and packages #167\nGeneral Troubleshooting"},{"_id":"47e77570f878e7d75700001a","treeId":"5f35a26e27e746044eeb0868","seq":21560265,"position":3,"parentId":"47e7781af878e7d757000015","content":"## Configuring Settings\n- [ ] #move to Configuring"},{"_id":"47e77517f878e7d75700001b","treeId":"5f35a26e27e746044eeb0868","seq":21560306,"position":1,"parentId":"47e77570f878e7d75700001a","content":"### Quick Start\n### Arches Production Deployment\n[ ] #delete \"Permissions Settings\" section (it's redundant, covered in Administering Arches content)\n[ ] #move the rest of this section to new Running Arches in Production section\n### Full Explanation of the System Settings UI"},{"_id":"47e7745ff878e7d75700001c","treeId":"5f35a26e27e746044eeb0868","seq":21560266,"position":4,"parentId":"47e7781af878e7d757000015","content":"## Projects and Packages"},{"_id":"47e773def878e7d75700001d","treeId":"5f35a26e27e746044eeb0868","seq":21560355,"position":1,"parentId":"47e7745ff878e7d75700001c","content":"### Projects\n### Packages"},{"_id":"47e77363f878e7d75700001e","treeId":"5f35a26e27e746044eeb0868","seq":21560267,"position":5,"parentId":"47e7781af878e7d757000015","content":"## Task Management"},{"_id":"47e77311f878e7d75700001f","treeId":"5f35a26e27e746044eeb0868","seq":21560303,"position":1,"parentId":"47e77363f878e7d75700001e","content":"### Dependencies\n[ ] #move this broker section to end of Software Dependencies\n\n### Configuration\n\n### Adding Tasks to Your Project\n\n### Running Celery\n\n[ ] #move the rest of the content (all but Dependencies) to new \"Task Management\" section in developing with Arches. (perhaps point to this section in the above Software Dependencies entry)\n"},{"_id":"4505695a3db1c9613700005a","treeId":"5f35a26e27e746044eeb0868","seq":21559477,"position":3.5,"parentId":null,"content":"# Configuring\n#new"},{"_id":"45051885968d9b9818000062","treeId":"5f35a26e27e746044eeb0868","seq":21559475,"position":3.75,"parentId":null,"content":"# Administering\n#new"},{"_id":"47e71bbbcd2834150d000021","treeId":"5f35a26e27e746044eeb0868","seq":21559474,"position":4,"parentId":null,"content":"# Using Arches"},{"_id":"47e718e8cd2834150d000022","treeId":"5f35a26e27e746044eeb0868","seq":21559638,"position":1,"parentId":"47e71bbbcd2834150d000021","content":"## Designing the Database\n- [ ] #move to Administering"},{"_id":"47e71877cd2834150d000023","treeId":"5f35a26e27e746044eeb0868","seq":21559646,"position":1,"parentId":"47e718e8cd2834150d000022","content":"### Arches Database Theory\n### Arches Designer\n### Graph Designer"},{"_id":"47e717bfcd2834150d000024","treeId":"5f35a26e27e746044eeb0868","seq":21559636,"position":2,"parentId":"47e71bbbcd2834150d000021","content":"## Ontologies in Arches\n- [ ] #move to Administering"},{"_id":"47e71770cd2834150d000025","treeId":"5f35a26e27e746044eeb0868","seq":21559648,"position":1,"parentId":"47e717bfcd2834150d000024","content":"### Loading an Ontology\n### Loading a custom ontology\n### Enforcing ontology rules"},{"_id":"47e716a8cd2834150d000026","treeId":"5f35a26e27e746044eeb0868","seq":21559634,"position":3,"parentId":"47e71bbbcd2834150d000021","content":"## Creating Resources\n- [ ] #rename Creating and Editing Resources"},{"_id":"47e71625cd2834150d000027","treeId":"5f35a26e27e746044eeb0868","seq":21560214,"position":1,"parentId":"47e716a8cd2834150d000026","content":"### Resource Manager\n### Resource Editor\n### Related Resources"},{"_id":"4504f0a2968d9b9818000065","treeId":"5f35a26e27e746044eeb0868","seq":21559632,"position":3.25,"parentId":"47e71bbbcd2834150d000021","content":"## Deleting Resources\n#new"},{"_id":"4504fe90968d9b9818000063","treeId":"5f35a26e27e746044eeb0868","seq":21559631,"position":3.5,"parentId":"47e71bbbcd2834150d000021","content":"## Searching \n#new also see in-app help"},{"_id":"47e71568cd2834150d000028","treeId":"5f35a26e27e746044eeb0868","seq":21559630,"position":4,"parentId":"47e71bbbcd2834150d000021","content":"## Managing Map Layers\n- [ ] #move to Administering"},{"_id":"47e714fbcd2834150d000029","treeId":"5f35a26e27e746044eeb0868","seq":21560216,"position":1,"parentId":"47e71568cd2834150d000028","content":"### Different Types of Layers"},{"_id":"47e71490cd2834150d00002a","treeId":"5f35a26e27e746044eeb0868","seq":21560270,"position":5,"parentId":"47e71bbbcd2834150d000021","content":"## Reference Data Manager (RDM)\n- [ ] #move to Administering"},{"_id":"47e71418cd2834150d00002b","treeId":"5f35a26e27e746044eeb0868","seq":21560217,"position":1,"parentId":"47e71490cd2834150d00002a","content":"### Concept Schemes"},{"_id":"47e71335cd2834150d00002c","treeId":"5f35a26e27e746044eeb0868","seq":21560271,"position":6,"parentId":"47e71bbbcd2834150d000021","content":"## Arches Collector Manager\n- [ ] #move to Administering"},{"_id":"47e712a5cd2834150d00002d","treeId":"5f35a26e27e746044eeb0868","seq":21560220,"position":1,"parentId":"47e71335cd2834150d00002c","content":"### What Are Arches Collector Projects?\n### Arches Collector Manager Overview\n### Creating Projects in the Arches Collector Manager\n### Creating an Offline Basemap"},{"_id":"47e71217cd2834150d00002e","treeId":"5f35a26e27e746044eeb0868","seq":21559473,"position":5,"parentId":null,"content":"# Using Arches Collector"},{"_id":"47e71109cd2834150d00002f","treeId":"5f35a26e27e746044eeb0868","seq":21560272,"position":1,"parentId":"47e71217cd2834150d00002e","content":"## Introduction to Arches Collector"},{"_id":"47e710c2cd2834150d000030","treeId":"5f35a26e27e746044eeb0868","seq":21560232,"position":2,"parentId":"47e71109cd2834150d00002f","content":"### General App Navigation"},{"_id":"47e7104ecd2834150d000031","treeId":"5f35a26e27e746044eeb0868","seq":21560273,"position":2,"parentId":"47e71217cd2834150d00002e","content":"## Arches Collector Workflow"},{"_id":"47e70feecd2834150d000032","treeId":"5f35a26e27e746044eeb0868","seq":21560233,"position":1,"parentId":"47e7104ecd2834150d000031","content":"### Connect to an Arches Instance\n### Download a Project\n### Navigating a Project\n### Creating Records\n### Editing Records\n### Syncing Data"},{"_id":"473c3c24ad5a3275b9000032","treeId":"5f35a26e27e746044eeb0868","seq":21559472,"position":6,"parentId":null,"content":"# Developing with Arches"},{"_id":"473c3bfead5a3275b9000033","treeId":"5f35a26e27e746044eeb0868","seq":21560275,"position":1,"parentId":"473c3c24ad5a3275b9000032","content":"## Additional Configuration\n- [ ] #delete once all content has been moved"},{"_id":"473c3381ad5a3275b9000034","treeId":"5f35a26e27e746044eeb0868","seq":21560234,"position":1,"parentId":"473c3bfead5a3275b9000033","content":"### Password Validators\n- [ ] #move to Configuring\nTime Wheel Configuration\n- [ ] #move to Configuring"},{"_id":"473c3320ad5a3275b9000035","treeId":"5f35a26e27e746044eeb0868","seq":21560276,"position":2,"parentId":"473c3c24ad5a3275b9000032","content":"## Arches and Elasticsearch"},{"_id":"473c32bdad5a3275b9000036","treeId":"5f35a26e27e746044eeb0868","seq":21560235,"position":1,"parentId":"473c3320ad5a3275b9000035","content":"### Installing and Running Elasticsearch\n### Reindexing The Database\n### Using Multiple Nodes\n### Adding a Custom Index"},{"_id":"473c326cad5a3275b9000037","treeId":"5f35a26e27e746044eeb0868","seq":21560278,"position":3,"parentId":"473c3c24ad5a3275b9000032","content":"## API"},{"_id":"473c321aad5a3275b9000038","treeId":"5f35a26e27e746044eeb0868","seq":21560236,"position":1,"parentId":"473c326cad5a3275b9000037","content":"### General Notes\n### Authentication\n#move Registering an application to Configuring #114\n### Concepts\n### Resources\n### Activity Stream\n### Mobile Projects\n### GeoJSON"},{"_id":"473c31e7ad5a3275b9000039","treeId":"5f35a26e27e746044eeb0868","seq":21560280,"position":4,"parentId":"473c3c24ad5a3275b9000032","content":"## Command Line Reference"},{"_id":"473c3172ad5a3275b900003a","treeId":"5f35a26e27e746044eeb0868","seq":21560239,"position":1,"parentId":"473c31e7ad5a3275b9000039","content":"### Installation Commands\n### ElasticSearch Management\n### Import Commands\n### Export Commands\n### Other Data Management Commands\n### Ontology Commands\n### Managing Functions, DataTypes, Widgets, and Card\n### Components\n### Creating Map Layers\n### Other Useful Django Commands"},{"_id":"473c307fad5a3275b900003b","treeId":"5f35a26e27e746044eeb0868","seq":21560282,"position":5,"parentId":"473c3c24ad5a3275b9000032","content":"## Creating a Development Environment"},{"_id":"473c302cad5a3275b900003c","treeId":"5f35a26e27e746044eeb0868","seq":21559434,"position":1,"parentId":"473c307fad5a3275b900003b","content":"### Setting Everything Up"},{"_id":"473c2fd1ad5a3275b900003d","treeId":"5f35a26e27e746044eeb0868","seq":21560281,"position":6,"parentId":"473c3c24ad5a3275b9000032","content":"## Creating New Functions, Widgets, Card Components, DataTypes, and Plugins"},{"_id":"473c2f8fad5a3275b900003e","treeId":"5f35a26e27e746044eeb0868","seq":21560240,"position":1,"parentId":"473c2fd1ad5a3275b900003d","content":"### Functions\n### Widgets\n### DataTypes\n### Card Components\n### Plugins"},{"_id":"473c2c0aad5a3275b900003f","treeId":"5f35a26e27e746044eeb0868","seq":21560283,"position":7,"parentId":"473c3c24ad5a3275b9000032","content":"## Creating New Map Layers"},{"_id":"473c2bacad5a3275b9000040","treeId":"5f35a26e27e746044eeb0868","seq":21560241,"position":1,"parentId":"473c2c0aad5a3275b900003f","content":"### MapBox Layers"},{"_id":"4504cda3968d9b9818000068","treeId":"5f35a26e27e746044eeb0868","seq":21560285,"position":7.5,"parentId":"473c3c24ad5a3275b9000032","content":"## Creating Reports \n#new #205"},{"_id":"473c2b63ad5a3275b9000041","treeId":"5f35a26e27e746044eeb0868","seq":21560284,"position":8,"parentId":"473c3c24ad5a3275b9000032","content":"## Data Model"},{"_id":"473c2afaad5a3275b9000042","treeId":"5f35a26e27e746044eeb0868","seq":21560242,"position":1,"parentId":"473c2b63ad5a3275b9000041","content":"### Resource Model Overview\n### Controllers\n### Graph Definition\n### Ontologies\n### RDM Models\n### Resource Data\n### UI Component Models\n [ ] #new Cardview Model #205\n [ ] #new Tileview Model #202\n\n### Data Model Graph Visualization"},{"_id":"4504cf44968d9b9818000067","treeId":"5f35a26e27e746044eeb0868","seq":21560287,"position":8.5,"parentId":"473c3c24ad5a3275b9000032","content":"## Localization\n#new #208"},{"_id":"473c2acaad5a3275b9000043","treeId":"5f35a26e27e746044eeb0868","seq":21560291,"position":9,"parentId":"473c3c24ad5a3275b9000032","content":"## Migrating Data from v3 to v4\n- [ ] #rename to Migrating Data from Earlier Versions"},{"_id":"473c2a6bad5a3275b9000044","treeId":"5f35a26e27e746044eeb0868","seq":21559439,"position":1,"parentId":"473c2acaad5a3275b9000043","content":"### Exporting Your Data From v3\n### Migrating Your Data"},{"_id":"473c2a3aad5a3275b9000045","treeId":"5f35a26e27e746044eeb0868","seq":21560292,"position":10,"parentId":"473c3c24ad5a3275b9000032","content":"## Resource Import/Export"},{"_id":"473c29c0ad5a3275b9000046","treeId":"5f35a26e27e746044eeb0868","seq":21560248,"position":1,"parentId":"473c2a3aad5a3275b9000045","content":"### Importing Data\n### Importing a CSV\n### Shapefile Import\n### JSON Import\n### Importing Resource Relations\n### Exporting Arches Data"},{"_id":"473c2933ad5a3275b9000047","treeId":"5f35a26e27e746044eeb0868","seq":21560293,"position":11,"parentId":"473c3c24ad5a3275b9000032","content":"## Settings - Beyond the UI"},{"_id":"45075b363db1c96137000055","treeId":"5f35a26e27e746044eeb0868","seq":21559485,"position":6.5,"parentId":null,"content":"# Running Arches in Production\n#new #11\n"},{"_id":"4506484e3db1c96137000056","treeId":"5f35a26e27e746044eeb0868","seq":21559494,"position":1,"parentId":"45075b363db1c96137000055","content":"## Serving Arches with Apache (moved from Reference)\n- [ ] #new moved here from Reference\n\n#125 includes new uploaded files content\n\n## Supervisord\n- [ ] #new moved here from Reference\n\n## Backing up the Database\n#new #132\n\n## Using AWS S3\n- [ ] #new migrated [from wiki](https://github.com/archesproject/arches/wiki/Storing-Media-on-AWS-S3)\n- Migrating a local app to EC2 (https://github.com/archesproject/arches/wiki/Migrating-a-Local-App-to-AWS-EC2)\n"},{"_id":"473c27d2ad5a3275b9000048","treeId":"5f35a26e27e746044eeb0868","seq":21560295,"position":7,"parentId":null,"content":"# References\n[ ] #delete this section, once all contents has been handled"},{"_id":"473c21dead5a3275b9000049","treeId":"5f35a26e27e746044eeb0868","seq":21559469,"position":1,"parentId":"473c27d2ad5a3275b9000048","content":"## Appendix A: Arches HIP\n\n#move to the readme file of this repo: https://github.com/archesproject/arches-example-pkg\n\n"},{"_id":"473c21a4ad5a3275b900004a","treeId":"5f35a26e27e746044eeb0868","seq":21560249,"position":2,"parentId":"473c21dead5a3275b9000049","content":"### Resource Models\n### Branches"},{"_id":"473c20f4ad5a3275b900004b","treeId":"5f35a26e27e746044eeb0868","seq":21559466,"position":2,"parentId":"473c27d2ad5a3275b9000048","content":"## Appendix B: Glossary\n- [ ] #delete this section in favor of the Glossary on archesproject.org"},{"_id":"4507bf6a3db1c96137000053","treeId":"5f35a26e27e746044eeb0868","seq":21560250,"position":1,"parentId":"473c20f4ad5a3275b900004b","content":"### Glossary"},{"_id":"473c20c9ad5a3275b900004c","treeId":"5f35a26e27e746044eeb0868","seq":21560294,"position":3,"parentId":"473c27d2ad5a3275b9000048","content":"## Appendix C: Serving Arches with Apache\n[ ] #move to Running Arches in Production section"},{"_id":"473c206cad5a3275b900004d","treeId":"5f35a26e27e746044eeb0868","seq":21560251,"position":1,"parentId":"473c20c9ad5a3275b900004c","content":"### Setup Apache\n### Handling Static Files"},{"_id":"473c2014ad5a3275b900004e","treeId":"5f35a26e27e746044eeb0868","seq":21559503,"position":4,"parentId":"473c27d2ad5a3275b9000048","content":"## Appendix D: Setting Up Supervisord For Celery\n\n- [ ] #move to new **Arches in Production** section"},{"_id":"4504b6b4968d9b981800006a","treeId":"5f35a26e27e746044eeb0868","seq":21559505,"position":4.5,"parentId":"473c27d2ad5a3275b9000048","content":"##Appendix E: Managing and Hosting IIIF Servers\n- [ ] #move to Developing #197"}],"tree":{"_id":"5f35a26e27e746044eeb0868","name":"Arches Documentation","publicUrl":"arches-documentation"}}