[Archivesspace_Users_Group] lcnaf plugin

Christine Di Bella christine.dibella at lyrasis.org
Thu May 20 15:13:33 EDT 2021

Hello Tom,

The LCNAF plugin is a very rare case in that it’s both bundled with the standard ArchivesSpace application and, because of its popularity, lives on its own in case it needs to be updated between our releases due to changes in LC’s service. The program team has discussed doing only one or the other because it is undeniably duplicative for code maintainers and confusing for users (though, on the users side, most people use the one that comes bundled with ArchivesSpace and don’t realize there is a separate one). The functionality of both LCNAF plugins is identical. For now we’ve continued to keep it the way it is pending some larger discussions.

Virtually all other plugins only live on our their own, and most plugins are authored by and maintained by community members, not the ArchivesSpace program. The community-maintained Awesome ArchivesSpace list links to a lot of great ones: https://github.com/archivesspace/awesome-archivesspace.

For some additional context, there’s some information about plugins and considerations for turning a plugin into core code at https://archivesspace.atlassian.net/wiki/spaces/ADC/pages/916062227/Making+a+Plug-In+part+of+the+Core+Code. That document also links to an outline of an evaluation process for considering feature contributions, including whether something might best be handled as a plugin: https://archivesspace.atlassian.net/wiki/spaces/ADC/pages/360546309/ArchivesSpace+Process+for+Evaluating+Potential+Feature+Contributions+to+the+Core+Code.

I hope this helps. If you have other questions, please let us know.


Christine Di Bella
ArchivesSpace Program Manager
christine.dibella at lyrasis.org<mailto:christine.dibella at lyrasis.org>
800.999.8558 x2905


From: archivesspace_users_group-bounces at lyralists.lyrasis.org <archivesspace_users_group-bounces at lyralists.lyrasis.org> On Behalf Of Tom Hanstra
Sent: Thursday, May 20, 2021 12:23 PM
To: Archivesspace Users Group <archivesspace_users_group at lyralists.lyrasis.org>
Subject: Re: [Archivesspace_Users_Group] lcnaf plugin

Ok, so I did not see that lcnaf was included in ArchivesSpace right from the beginning. I thought I had to get the files from GitHub as I would with other plugins, but I see that they are there. In fact several are there.

So I need to revise my overall question to:

- Why is some code added to the zip file but left as a plugin while other code is added to the software?

In this instance, lcnaf is there but I need to update the config file to turn it on. With other plugins, I have to get the files from somewhere else and turn them on. And maybe do more than just put them in the directory (for instance, oauth needs to be compiled). How is it determined what goes where and how it is or is not included?

Sorry, but this is rather confusing to the newbie.


On Thu, May 20, 2021 at 10:51 AM Joshua D. Shaw <Joshua.D.Shaw at dartmouth.edu<mailto:Joshua.D.Shaw at dartmouth.edu>> wrote:
Hi Tom

To enable any plugin in the /plugins directory, you need to update the config file. Specifically, the entry

AppConfig[:plugins] = []

The array contents are just the directory names of the plugins that you want to enable

So, to enable just the lcnaf plugin, you would want

AppConfig[:plugins] = ['lcnaf']

https://archivesspace.github.io/tech-docs/ is a good resource.


From: archivesspace_users_group-bounces at lyralists.lyrasis.org<mailto:archivesspace_users_group-bounces at lyralists.lyrasis.org> <archivesspace_users_group-bounces at lyralists.lyrasis.org<mailto:archivesspace_users_group-bounces at lyralists.lyrasis.org>> on behalf of Tom Hanstra <hanstra at nd.edu<mailto:hanstra at nd.edu>>
Sent: Thursday, May 20, 2021 9:09 AM
To: Archivesspace Users Group <archivesspace_users_group at lyralists.lyrasis.org<mailto:archivesspace_users_group at lyralists.lyrasis.org>>
Subject: [Archivesspace_Users_Group] lcnaf plugin

Hi, ArchivesSpace users,

I continue my quest to get our site set up and have been told that I need to install the lcnaf plugin. I've got a few questions:

First, where is the documentation on how to install the plugin? The code in github does not have so much as a README file to give me information on how to install it. Do I just grab the code and plunk it into the plugins directory? Or is there more to be done?

Second, how does ArchivesSpace decide what plugins get pulled into code and which do not. This one, from what I can tell, has been around for a long time and yet continues to be a plugin that is added after the fact. Yet other plugins have been added into the code. Just curious how that gets decided.


Tom Hanstra
Sr. Systems Administrator
hanstra at nd.edu<mailto:hanstra at nd.edu>

Archivesspace_Users_Group mailing list
Archivesspace_Users_Group at lyralists.lyrasis.org<mailto:Archivesspace_Users_Group at lyralists.lyrasis.org>

Tom Hanstra
Sr. Systems Administrator
hanstra at nd.edu<mailto:hanstra at nd.edu>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_users_group/attachments/20210520/c0627228/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.jpg
Type: image/jpeg
Size: 13904 bytes
Desc: image001.jpg
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_users_group/attachments/20210520/c0627228/attachment.jpg>

More information about the Archivesspace_Users_Group mailing list