A repository for depositing, managing, and discovering
Electronic Theses and Dissertations (ETDs).
or cherokee rose is the state flower of Georgia.
Environment variables in development
See the dotenv sample file for environment variables you may need to set in your development environment.
Cron jobs in production
There are certain cron jobs that are expected to run in production. These include graduation job,
fixity audit, embargo expiration, and others. We use the
whenever gem to manage these.
If you need to make changes to the scheduled jobs, please update
config/schedule.rb and the new crontab should be installed via capistrano when the code is deployed.
Please note that in order to run as expected, the PATH must be defined: run
crontab -e as the
deploy user and
ensure these lines are at the top of your cron file:
Please ensure that any scheduled jobs write to the rails log file so we can track whether they are running as expected.
Suppressing email for bouncing addresses
If an email address is bouncing, or if someone prefers not to receive email notifications,
add the email address to the list in
Copying embargo notification emails to a staff member
To send a copy of all notification expiration emails to a staff member, add that person's uid to an environment variable called EMBARGO_NOTIFICATION_CC in the .env.production file on the production server (other servers are configured not to send email).
- Change to your working directory for new development projects
- Clone this repo
git clone https://github.com/curationexperts/laevigata.git
- Change to the application directory
- Use set your ruby version to 2.4.2 and the gemset of your choice
rvm use --create 2.4.2@laevigata
- Install gem dependencies
- Ensure you have
brew install yarnor
npm install -g yarn
- Install yarn dependencies
- Start redis
redis-server ¬e: use
&to start in the background, or run redis in a new terminal session
- Setup environment variables for your development environment:
cp dotenv.sample .env.development, see the Environment variables in development section for more details
- Read the section on 'Database Authentication' below and decide if you want to set up your environment for database authentication.
- Start the demo server in its own terminal session
- Start the webpack dev server
- Run the first time setup script
- Run the test suite
In production, we use Shibboleth exclusively for user authentication. However, authenticating to Shibboleth from your local development environment might not be feasible. Instead, you'll want to set up local database authentication.
To set your dev environment for database authentication, you need to set this environment variable:
User and workflow setup
Each Emory school has its own AdminSet, which determines the approval process for that
school, and who can approve deposited ETDs. Running
rake db:seed will create an AdminSet for each school in the schools.yml file, load the appropriate workflow, and set permissions such that any registered user can deposit.
rake db:seed should be idempotent -- you can run it over and over again safely.
A "superuser" can manage all admin_sets, edit all ETDs, and approve submissions
everywhere. To create a new superuser, add the user's email address to the
config/emory/superusers.yml file. Then run
rake db:seed to reload the config. Until we get real authentication running, the password for all superusers is
Note: Do not run
bin/setup except the very first time you setup the application, or if you need to wipe out everything in your development instance. It will wipe your database but leave your AdminSets in place, making a huge mess that you can't easily recover from.
Browse Everything (Box integration)
These instructions work for setting up a key either for a server or for local testing.
- Go to
https://app.box.com/developers/console/newappand log in as yourself (this will be your personal developer account credentials)
- Select 'custom application' and hit 'next'
- Select 'Standard OAuth 2.0 (User Authentication)' and hit 'next'
- Give your app a unique name (e.g., "laevigata-yourname" or "etd-staging-upgrade") and it will give you a url like:
curl https://api.box.com/2.0/folders/0 -H \ "Authorization: Bearer lCuEl1KbmQzIQut6HVFR3IlZ4TkAaCMK"
- Go to
- Click on your app name, and then on the 'Configuration' tab on the left.
- In a box labeled OAuth 2.0 Credentials you will see your OAuth credentials. You'll need these.
- Set the
OAuth 2.0 Redirect URIvalue to
https://SERVER_NAME/auth/box/(with the slash at the end) Or, if this is your local dev box, the value might be
- Set the CORS domain to
https://SERVER_NAME(without a slash at the end) Or, if this is your local dev box, the value might be
- Set the
OAuth 2.0 Redirect URIvalue to
- Leave the CORS domain blank
- Save changes
Adding box credentials to a server
Add the credentials you just made to the
.env.production file on the server where the application is running. Ideally, add them to ansible so they are maintained in
version control and the server can be re-built with these credentials in place.
Adding box credentials locally
- Follow these instructions: https://github.com/samvera/browse-everything/wiki/Configuring-browse-everything
rails g browse_everything:config
- copy the
client_secretfrom box into your newly created
config/browse_everything_providers.ymlfile and uncomment the
- The generator will try to add the BrowseEverything mount to your
config/routes.rbfile. This already exists in Laevigata, so remove the line it added.
- Save everything and restart your rails server and you should be good to go!