Provides the arks.org website and ARK resolver service.
Deployment and configuration is performed by a combination of puppet and ansible. These provide a deployment of arks.org on AWS EC2 instance listening on HTTP port 18880.
See UC3 Puppet module uc3_ezid_arks and ansible playbook deploy_arksorg_site.
For manual installation notes see Manual Installation on AWS EC2.
-
Create and activate a virtual environment.
-
Clone the repo
git clone https://github.com/CDLUC3/arksorg-site.git
cd arksorg-site
- Install using
poetryorpip
poetry install
or
pip install -r requirements.txt
- Set a local configuration, dev-config.env
ARKS_DEVHOST=localhost
ARKS_DEVPORT=8000
ARKS_DB_CONNECTION_STRING="sqlite:///data/registry.sqlite"
ARKS_ENVIRONMENT="development"
ARKS_SERVICE_PATTERN="(^https?://localhost:8000/)|(^https?://localhost:8000/)|(^https?://?n2t.net/)|(^https?://?arks.org/)"
LOG_LEVEL="debug"
DEBUG_SQL=false
ARKS_NAANS_SOURCE="https://cdluc3.github.io/naan_reg_priv/naan_records.json"
- Configure the local NAAN database
mkdir data
python -m arks -c dev-config.env load-naans
Note that this operation should be run periodically to keep the local NAAN registry up to date with the source.
- Run the local server
Install uvicorn to enable the local server:
pip install uvicorn
Then run the local server:
python -m arks -c dev-config.env serve