Arches Collector Checklist¶
The following steps must be completed to enable an Arches Collector connection with your Arches instance.
Ubuntu 20 users must install CouchDB 2.x with Docker.
Arches uses CouchDB 2.x, though the current version of CouchDB is 3.x. If
you already have 3.x installed, use
sudo apt-get --purge remove couchdb to start
# only if you haven't already done this wget --quiet -O - https://couchdb.apache.org/repo/bintray-pubkey.asc | sudo apt-key add - sudo add-apt-repository "deb https://apache.bintray.com/couchdb-deb $(lsb_release -sc) main" sudo apt-get update # necessary to find the older release sudo apt-cache policy couchdb sudo apt-get update
this will list all available versions — make note of the latest version 2 and then install it:
sudo apt-get install couchdb=2.3.1~bionic
For the quickest installation configuration, choose standalone, 127.0.0.1, and pick your password.
Test the installation with
curl http://admin:[your password]@127.0.0.1:5984,
the response should contain the correct version number.
Finally, add this line to
COUCHDB_URL = 'http://admin:[your password]@127.0.0.1:5984'
At this point you should be ready to move on, but see the official CouchDB setup documentation for more information.
Register an OAuth Application¶
To allow others to connect to your Arches instance, including Arches Collector users, you must create an OAuth client id and add it to your settings.
In a browser go to
Create a new application
Fill out the form with a Name of your choosing, and set Client type and Authorization grant type as shown in the image below.
Copy the Client id and submit the form (you can access this id at any time).
In your Arches project’s
settings_local.pyfile, set or add this variable
MOBILE_OAUTH_CLIENT_ID = "<your new Client id>"
Only make one application, though you are technically allowed to make more.
An application is “owned” by whichever user created it, and will not be visible to other users.