Merge pull request #257 from pulibrary/sandbergja-patch-2

Add steps for installing a plugin in a local archivesspace
pulibrary · Dec 12, 2024 · 90468c7 · 90468c7
2 parents 31eb3b2 + bd63749
commit 90468c7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/aspace.md b/aspace.md
@@ -62,3 +62,9 @@ supervisord -c supervisord/archivesspace.conf
 * The API will be at http://localhost:4567/
 * You can access the database with `mysql --host=127.0.0.1 --port=3306  -u root -p123456 archivesspace`
 
+### Installing a plugin in your local development
+
+1. `cp config/config-example.rb config/config.rb`.
+2. Edit the plugin array in `config/config.rb` to add your plugin.
+3. Add the code for your plugin to the `plugins` directory.
+4. Ctrl+C your supervisord and start it again.