Skip to content

ANW-2717 embedded database will be deprecated soon #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brianzelip merged 1 commit into from
May 14, 2026
Merged

ANW-2717 embedded database will be deprecated soon #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/content/docs/administration/getting_started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,22 @@ the application. Everything else will be treated as "best effort" community-led

See [Running with external Solr](/provisioning/solr) for more information on installing and upgrading Solr.

##### Database
#### Database
Copy link
Copy Markdown
Collaborator

@brianzelip brianzelip May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thimios did you mean to remove this Database section out of the “Software requirements “ section?


While ArchivesSpace does include an embedded database, MySQL is required for production use.

(While not officially supported by ArchivesSpace, some community members use MariaDB so there is some community support for version 10.4.10 only.)

**The embedded database is for testing purposes only. You should use MySQL or MariaDB for any data intended for production, including data in a test instance that you intend to move over to a production instance.**

All ArchivesSpace versions can run on MySQL version 5.x or 8.x.

##### Note on running with the embedded database

**The embedded database is for testing purposes only. We recommend using MySQL for any data intended for production, including data in a test instance that you intend to move over to a production instance.**

The embedded database has been available when using the `.zip` distribution of ArchivesSpace as an easy way to get up and running a demo ArchivesSpace system without having to setup MySQL. It will be deprecated in the upcoming major release of ArchivesSpace.

See the [Running with Docker](/administration/docker/) page for instructions on how to install ArchivesSpace using Docker which is the recommended way to setup an ArchivesSpace system with minimal effort.

#### Install and run

Download the distribution `.zip` for your version from [ArchivesSpace releases on GitHub](https://github.com/archivesspace/archivesspace/releases).
Expand Down