Skip to content
This repository has been archived by the owner on Jun 30, 2021. It is now read-only.

Feature Request: Create Dockerfile to encourage local usage #235

Open
machawk1 opened this issue Dec 19, 2018 · 4 comments
Open

Feature Request: Create Dockerfile to encourage local usage #235

machawk1 opened this issue Dec 19, 2018 · 4 comments
Labels

Comments

@machawk1
Copy link

Is your feature request related to a problem? Please describe.
I was hoping to test AUK on my local system (I have only ever used it at https://cloud.archivesunleashed.org/) but may have a clash in dependencies based on other tools.

Describe the solution you'd like
Docker is often the remedy for this sort of issue and would allow local AUK instances to be self-contained. I did not see mention of it in the repo but having one may encourage local usage. The solution I am proposing is to create a Dockerfile and provide rudimentary instructions on local usage.

Describe alternatives you've considered
Installing all of the dependencies on my local system. This is not ideal and not nearly as easy as using the site, though requires me to be connected to the 'net.

Additional context
As additional context, we (@oduwsdl and most often @ibnesayeed) have gone through the procedure of "Dockerization" with various tools before. I believe @ibnesayeed even did so for https://github.com/helgeho/ArchiveSpark, so there might be a template to build on.

@ibnesayeed
Copy link

@machawk1 there is a separate repository for its Dockerization at https://github.com/archivesunleashed/docker-aut, which, I opposed in the very early days as it has numerous maintenance and development issues. However, the maintainers of this repo perhaps feel differently and they might find their current approach more suitable to their workflow.

@machawk1
Copy link
Author

@ibnesayeed It is not clear in docker-aut repo how much of AUK is AUT (and vise-versa). Additionally, to what extent is the functionality provided in the docker-aut repo covered in the README of the auk repo. This would be a question for someone more familiar with the internals/progress of the project (e.g., @ruebot).

@ibnesayeed
Copy link

You are right, I was confused between aut and auk. My original (rejected) PR in the aut repo can be found at archivesunleashed/aut#40.

@ruebot
Copy link
Member

ruebot commented Dec 20, 2018

docker-aut:

This is the Docker image for Archives Unleashed Toolkit. AUT documentation can be found here. If you need a hand installing Docker, check out our Docker Install Instructions, and if you want a quick tutorial, check out our Hands on With The Archives Unleashed Toolkit.

The Archives Unleashed Toolkit is part of the broader Archives Unleashed Project.

aut is a library for Apache Spark. docker-aut provides you a very basic environment to experiment with Apache Spark with aut loaded. That repo's main use is for pedagogical purposes.


As for the issue at hand, setting up auk with Docker is not a priority for the project now. There is a chance we might come back to it later so I'll mark it as on-hold.

@ruebot ruebot added the on hold label Dec 20, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants