# [Archivematica]

By [Artefactual]

[![GitHub CI]][Test workflow]
[![codecov]][Archivematica Codecov]

Archivematica is a web- and standards-based, open-source application which
allows your institution to preserve long-term access to trustworthy,
authentic and reliable digital content.
Our target users are archivists, librarians, and anyone working to preserve
digital objects.

You are free to copy, modify, and distribute Archivematica with attribution
under the terms of the AGPLv3 license.
See the [LICENSE] file for details.

## Installation

* [Production installation]
* [Development installation]

## Using Archivematica

* [Website] for the user and administrator documentation
* [Presentations repo] and [YouTube channel] for previous trainings and talks
* [Case studies repo] for a collection of resources about working on and with
Archivematica
* [User Group] is a forum/mailing list for user questions (both
technical and end-user)
* [Paid support] is for paid support, hosting, training, consulting
and software development contracts from Artefactual

## Developing with Archivematica

* [Archivematica API documentation] for getting to know the Archivematica API
* [Developer guide] is the developer facing documentation, requirements
analysis and community resources
* [Issues] is the Git repository used for tracking Archivematica issues
and feature/enhancement ideas
* The [Archivematica roadmap] contains current release information and potential
future works

## Contributing

Thank you for your interest in Archivematica!

For more details, see the [contributing guidelines].

Read about our guidelines for making [pull requests], including [contribution
standards], and make any [documentation updates] reflecting the changes
introduced by your contribution.

Our [Contributors Portal] contains useful background information and
instructions on translations in Archivematica.

You might have questions about the history of development decisions: find
answers in the [Architectural Decisions Record].

Our current release notes are available on GitHub. Release notes since version
0.6 are available in the [RELEASENOTES file].

## Reporting an issue

Issues related to Archivematica, the Storage Service, or any related
repository can be filed in the [Issues] repository.

Read our guide about [issue reporting].

### Security

If you have a security concern about Archivematica or any related repository,
please see the [SECURITY file] for information about how to
safely report vulnerabilities.

## Related projects

Archivematica consists of several projects working together, including:

* [Archivematica][Archivematica GitHub]: This repository! Main
  repository containing the user-facing dashboard, task manager
  MCPServer and clients scripts for the MCPClient
* [Storage Service] : Responsible for moving files to Archivematica for
  processing, and from Archivematica into long-term storage
* [Format Policy Registry] : Submodule shared between Archivematica and
  the Format Policy Registry (FPR) server that displays and updates FPR
  rules and commands

For more projects in the Archivematica ecosystem, see the list on the
[dependencies] page of the [Contributors Portal].

[Architectural Decisions Record]: https://adr.archivematica.org/
[Archivematica API documentation]: https://archivematica.org/docs/latest/dev-manual/api/api-reference-archivematica/#api-reference-archivematica
[Archivematica Codecov]: https://codecov.io/gh/artefactual/archivematica
[Archivematica GitHub]: https://github.com/artefactual/archivematica
[Archivematica]: https://www.archivematica.org/
[Archivematica roadmap]: https://github.com/archivematica/Issues/wiki/Archivematica-Roadmap
[Artefactual]: https://www.artefactual.com/
[Case studies repo]: https://github.com/archivematica/archivematica-case-studies
[codecov]: https://codecov.io/gh/artefactual/archivematica/branch/qa/1.x/graph/badge.svg?token=tKlfjhmrlC
[contributing guidelines]: https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md
[contribution standards]: https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md#contribution-standards
[Contributors Portal]: https://contributors.artefactual.com/
[dependencies]: https://contributors.artefactual.com/dependencies.html#archivematica
[Developer guide]: https://github.com/artefactual/archivematica/blob/qa/1.x/hack/README.md
[Development installation]: https://github.com/artefactual/archivematica/tree/qa/1.x/hack
[documentation updates]: https://github.com/artefactual/archivematica-docs/wiki
[Format Policy Registry]: https://github.com/artefactual/archivematica/tree/qa/1.x/src/archivematica/dashboard/fpr
[GitHub CI]: https://github.com/artefactual/archivematica/actions/workflows/test.yml/badge.svg
[issue reporting]: https://github.com/archivematica/Issues/blob/main/CONTRIBUTING.md
[Issues]: https://github.com/archivematica/Issues
[LICENSE]: LICENSE
[Paid support]: https://www.artefactual.com/services/
[Production installation]: https://www.archivematica.org/docs/latest/admin-manual/installation-setup/installation/installation/
[pull requests]: https://github.com/artefactual/archivematica/blob/qa/1.x/CONTRIBUTING.md#getting-started
[RELEASENOTES file]: RELEASENOTES.md
[SECURITY file]: SECURITY.md
[Presentations repo]: https://slideshare.net/Archivematica/presentations
[Storage Service]: https://github.com/artefactual/archivematica-storage-service
[Test workflow]: https://github.com/artefactual/archivematica/actions/workflows/test.yml
[User Group]: https://groups.google.com/forum/#!forum/archivematica
[Website]: https://www.archivematica.org/
[YouTube channel]: https://www.youtube.com/@ArtefactualSystems