Skip to content

Latest commit

 

History

History
118 lines (97 loc) · 3.9 KB

RepoREADME.md

File metadata and controls

118 lines (97 loc) · 3.9 KB
Raw

University of Tennessee Knoxville

Table of Contents

Prerequisites

Install Docker

Install Dory

On OS X or Linux we recommend running Dory. It acts as a proxy allowing you to access domains locally such as app.test or tenant.app.test, making multitenant development more straightforward and prevents the need to bind ports locally. Be sure to adjust your ~/.dory.yml file to support the .test tld.

You can still run in development via docker with out Dory, but to do so please uncomment the ports section in docker-compose.yml

gem install dory

Running the stack

Getting Started

  1. Clone the repository and cd into the folder

  2. Install Stack Car

gem install stack_car
  1. If this is the first time building the application or if any of the dependencies changed, please build with:
sc build
  1. After building the application please install and start dory:
dory up
  1. Bring the container up with:
sc up
  1. Once the application is up and running, navigate to utk-hyku.testin the browser and log in with the following credentials in 1Pass
  • When loading a tenant you may need to login through the browser: un: samvera pw: hyku

Metadata Profiles

In order to create or import any models, a metadata profile must be uploaded. The name of any new model(s) must be included in the "classes" block of the yml file:

  • Dashboard >> Metadata Profiles >> Import Profile
  • Bash into the container and run: 
    rails generate allinson_flex:works --include_module BulkraxMetadata
  • Restart the server
  • Dashboard >> Settings >> Available work types >> checkmark the newly added classes and save the changes
  • Bash into the container again and run: 
    rails allinson_flex:run_additional_configurations
  • Go into your newly created model file and add the title validation: 
      # app/models/my_new_model.rb
  include Validations
  • Go into your newly created form file and update the base_terms: 
      # app/forms/hyrax/my_new_model_form.rb
  include UtkBaseTerms
# example yml file
# the "title" property will be added as a required field to all models even if it isn't set in this file
# due to existing model validations
...
classes:
  Audio:
    display_label: "Audio"
  GenericWork:
    display_label: "Generic Work"
properties:
  creator:
    display_label:
      default: "Creator"
    available_on:
      class:
        - Audio
        - GenericWork
...
  • Dashboard >> Metadata Profiles >> Import Profile

Troubleshooting

  • Is dory up? Check with a docker ps do you see the dory container up and running? If not run dory up

  • Did you adjust your ~/.dory.yml file to support the .test tld?

  • Did you checkout main and give it a git pull?

    • In that git pull were there any updates to the config files? Do you need to rebuild with sc build?
    • If that does not work, your last ditch effort is to do a no-cache build (but it takes forever so talk to the Project Manager at this point to see what you should do with your time, rebuild or get help). 
      # drop all containers and volumes
docker-compose down -v
docker-compose build --no-cache
sc up