arche-localhost-utils

A bunch of shell scripts to ease working with arche locally

i don't want to type sudo all the time

on default you can execute docker related commands only with sudo; to change this you have a look at https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user (TLDR, create a docker group and add you user to it; restart the system)

how to install

• Clone the repo
• One time: run ./init-repo.sh to create needed directories
  • answer VOLUMES_DIR env var is not set, please provide the installation directory: with .
• To (re)start the continer run ./docker-start.sh
  • Be aware full repository initialization at the first run (particularly external vocabularies import) may take a lot of time. Anyway once # Running 40-updateVocabularies.php initialization stage is reached you may safely start using the repository without further waiting.
  • This repo ships with a database dump to skip avoid initial download of external vocabulaires
  • To stop the container run docker container stop acdh-repo
• To remove all data run ./reset-repo.sh
• To remove everything just delete the current folder

enter a running container

docker exec -it -u www-data acdh-repo bash (or run ./enter-repo.sh)

check initscript logs

• inside the container (see above), look around ls
• to inspect initscript logs run tail -f log/initScripts.log

the GUI

you should mainly focus on ARCHEs API, but you can find the ARCHE-GUI at http://localhost/browser/

local PHP setup

• either install all needed things; see information about the needed PHP setup to run ingestions and file checks can be found here

• or user docker

how to test

for the following steps make sure you are in the testing directory (cd testing)

ingest metadata

docker setup

• first create and enter a php/arche container by running ./enter_php_container.sh
• you are now in the mounted testing directory (which inside the docker is called data); if you look around (ls) you should see the same files as in the host`s testing repo.
• run ./metadata_ingest.sh

composer setup

• run ./metadata_ingest.sh to ingest the "Die eierlegende Wollmilchsau"
• see arche-ingest for some documentation

run filechecker

docker setup

• first create and enter a php/arche container by running ./enter_php_container.sh
• you are now in the mounted testing directory (which inside the docker is called data); if you look around (ls) you should see the same files as in the host`s testing repo.
• run ./filechecker.sh
• check the results in testing/fc_out/{datetime-of-last-run} (e.g. cd into the directory, start python dev server python -m http.server and open the printed URL)
• spoileralert: 2/3 files did not pass the test!

composer setup

• run ./filechecker.sh
• check the results in testing/fc_out/{datetime-of-last-run} (e.g. cd into the directory, start python dev server python -m http.server and open the printed URL)
• spoileralert: 2/3 files did not pass the test!

ingest binaries

docker setup

• first create and enter a php/arche container by running ./enter_php_container.sh
• you are now in the mounted testing directory (which inside the docker is called data); if you look around (ls) you should see the same files as in the host`s testing repo.
• run ./binaries_import.sh

composer setup

• (well you actually shouldn't do that, because they didn't pass the filechecker)
• run ./binaries_import.sh
• see repo-file-checker for some documentation

add new dump

• remove everything and clone the repo again
• comment # cp dump.sql -d ${VOLUMES_DIR}/data in init-repo.sh
• enter container ./enter-repo.sh
• change user su www-data
• create dump pg_dumpall -f data/dump.sql
• leave container
• copy data.sql into repo root