Public Repository

Last pushed: 2 days ago
Short Description
RODA is an OAIS reference model compliant digital repository.
Full Description

What is RODA

RODA is a digital repository solution that delivers functionality for all the main units of the OAIS reference model. RODA is capable of ingesting, managing and providing access to the various types of digital objects produced by large corporations or public bodies. RODA is based on open-source technologies and is supported by existing standards such as the Open Archival Information System (OAIS), Metadata Encoding and Transmission Standard (METS), Encoded Archival Description (EAD), Dublin Core (DC) and PREMIS (Preservation Metadata).

Start a RODA instance

Starting a RODA instance is simple:

Linux

On Linux, use the following instructions:

  1. Install docker for your system: https://docs.docker.com/engine/installation/
  2. Pull or update to the latest roda container, on the command line run: sudo docker pull keeps/roda
  3. Run the container: sudo docker run -p 8080:8080 -v ~/.roda:/root/.roda keeps/roda
  4. Access RODA on your browser: http://localhost:8080

NOTE: the docker commands only need sudo if your user does not belong to the docker group.

To start as a service you can install supervisord and create the file /etc/supervisor/conf.d/roda.conf with:

[program:roda]
command=docker run -p 8080:8080 -v /home/roda/:/root/.roda keeps/roda
directory=/tmp/
autostart=true
autorestart=true
startretries=3
stderr_logfile=/var/log/supervisor/roda.err.log
stdout_logfile=/var/log/supervisor/roda.out.log
user=roda
  1. Create user 'roda': sudo adduser roda
  2. Add user 'roda' to 'docker' group: sudo usermod -aG docker roda
  3. Then restart supervisord (sudo service supervisord restart)

MacOS

Just install Kitematic, and search for "roda". Install and run docker container. It's that easy.

Kitematic is like an AppStore that automates the Docker installation and setup process and provides an intuitive graphical user interface (GUI) for running Docker containers (i.e. lightweight Virtual Machines).

Windows

Just install Kitematic, and search for "roda". Install and run docker container. It's that easy.

Kitematic is like an AppStore that automates the Docker installation and setup process and provides an intuitive graphical user interface (GUI) for running Docker containers (i.e. lightweight Virtual Machines).

What to do after starting RODA

After starting a RODA instance, direct your browser to the correct IP address (usually http://localhost:8080/ ; this depends on your installation mode and used settings) and log in with the following credentials:

  • Username: admin
  • Password: roda

With this you will have access to all features.

Then you can start using RODA:

  1. Go to Catalogue and click the button NEW, select Dublin Core and fill the title of your new collection.
  2. Go to Ingest > Transfer and upload files (e.g. PDF) or SIPs made by RODA-in. SIPs will have metadata while PDFs wont. To know how to use RODA-in watch the tutorials.
  3. After upload, select the SIPs or files to ingest on the checkbox and click the button PROCESS on the sidebar under the section Ingest.
  4. Now configure the ingest workflow, select the SIP format, if you upload a file select Uploaded file/folder, if you uploaded a SIP select the SIP format (E-ARK or Bagit).
  5. Under the Parent Object you can select the new collection you created above.
  6. After configuring ingest click the CREATE button.
  7. Now ingest will start and you can see the status of it at Ingest > Process, you can also inspect the status by clicking the table row.
  8. When finished you can go to Catalogue or Search to find your new ingested content.

Caveats

The RODA docker container has some limitations on Windows due to filename incompatibilities. This means that you will be limited to the storage capacity within the container. If you change the default configuration to use the storage of the host machine it will not work.

Documentation

Documentation about RODA is available at RODA's GitHub repository.

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Docker Pull Command
Owner
keeps

Comments (2)
lfaria
a year ago

@mtycz as we completely refactored the code, we will not be making docker images for releases under 2.X. But we will make tags on releases after 2.X.

mtycz
a year ago

It would be super useful if there were also tags for released versions of Roda (v1.1.0, v1.2.0 and v.1.3.0).
Do you plan to add them?