Deric (UC DRC)

Dependencies

***Our Hyrax 2.x based app requires the following software to work:

• Solr version >= 5.x (tested up to 6.2.0)
• Fedora Commons digital repository version >= 4.5.1 (tested up to 4.6.0)
• A SQL RDBMS (MySQL, PostgreSQL), though note that SQLite will be used by default if you're looking to get up and running quickly
  • libmysqlclient-dev (if running MySQL as RDBMS)
  • libsqlite3-dev (if running SQLite as RDBMS)
• Redis, a key-value store
• ImageMagick with JPEG-2000 support
• FITS version 1.0.x (1.0.5 is known to be good)
• LibreOffice

Installing the UC DRC application

1. Clone this repository: git clone https://github.com/uclibs/uc_drc.git ./path/to/local

   Note: Solr will not run properly if there are spaces in any of the directory names above it
   (e.g. /user/my apps/uc_drc/)

2. Change to the application's directory: e.g. cd ./path/to/local
3. Make sure you are on the develop branch: git checkout master
4. Install bundler (if needed): gem install bundler
5. Run bundler: bundle install
6. Start fedora: fcrepo_wrapper -p 8984
7. Start solr: solr_wrapper -d solr/config/ --collection_name hydra-development
8. Start redis: redis-server
9. Run the database migrations: bundle exec rake db:migrate
10. Start the rails server: rails server
11. Visit the site at [http://localhost:3000] (http://localhost:3000)
12. Create default admin set: bin/rails hyrax:default_admin_set:create
13. Create default collection: bundle exec rails hyrax:default_collection_types:create
14. Load workflows: bin/rails hyrax:workflow:load
    • Creating default admin set should also load the default workflow. You can load, any additional workflows defined, using this command.
15. Assigning admin role to user from rails console:
    • admin = Role.find_or_create_by(name: "admin")
    • admin.users << User.find_by_user_key( "[email protected]" )
    • admin.save
    • Read more.
16. Set up profiles and classes: Open the app in a browser as Admin and navigate to the Hyrax Dashboard > Metadata Profiles and click Import Profile.
    • You can select the example profile in config/metadata_profile/hyrax.yaml
17. Generate example/test users with roles bin/rails db:seed
    • Read more

Running the Tests

1. Start fedora: fcrepo_wrapper -p 8986
2. Start solr: solr_wrapper -d solr/config/ --collection_name hydra-test -p 8985
3. Start redis: redis-server
4. Run the database migrations: bundle exec rake db:migrate (Optional)
5. Run the test suite: bundle exec rake spec

Docker

Deric includes a docker-compose file and Docker configuraiton to run the app in develop mode. Execute docker commands from the root of the application directory as follows:

• Start the application: docker-compose up -d

  Note: Application will build automatically on initial start

• List running Docker containers: docker ps
• Inspect logs from a container: docker logs <container name>

  Note: add -f flag to stream the log

• Run a command on a container by name: docker exec -it <container name> <command>
• Attach to command line in a container: docker exec -it <container name> bash
• Stop the application, retain data: docker-compose down
• Stop the application, delete all data: docker-compose down -v
• Rebuild the application after code/git branch changes (retains data): docker-compose up -d --build
• The application runs in development as default. To start the application in production mode, prepend the proper RAILS_ENV when starting docker: RAILS_ENV=production docker-compose up -d --build

Run the application production mode

• RAILS_ENV=production docker-compose up -d

Run spec tests in Docker

• docker run web test

Project Samvera

This software has been developed by and is brought to you by the Samvera community. Learn more at the Samvera website