Skip to content

Commit e44354f

Browse files
thimiosthimios
committed
ANW-2218 add docker support on production
1 parent 9588608 commit e44354f

File tree

9 files changed

+239
-135
lines changed

9 files changed

+239
-135
lines changed

‎src/content/docs/administration/dockerized_service.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: When using Docker
3+
---
4+
5+
Running archivespace using Docker makes it easy to run in as a system service.

‎src/content/docs/administration/getting_started.md

Lines changed: 0 additions & 124 deletions
This file was deleted.

‎src/content/docs/development/docker.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ title: Docker
44

55
The [Docker](https://www.docker.com/) configuration is used to create [automated builds](https://hub.docker.com/r/archivesspace/archivesspace/) on Docker Hub, which are deployed to [the latest version](http://test.archivesspace.org) when the build completes.
66

7-
Please note:
8-
9-
- Docker is not supported as an install method.
10-
- Docker configuration is being used for internal purposes only.
11-
- Use of Docker by anyone else is "use at your own risk".
12-
- Docker related files may be updated at anytime without warning or presence in release notes.
13-
147
## Custom builds
158

169
Run ArchivesSpace with MySQL, external Solr and a Web Proxy. Switch to the

‎src/content/docs/getting_started/docker.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: Running with Docker
3+
---
4+
5+
## Installing
6+
7+
The easiest way to get ArchivesSpace up and running is using [Docker](https://www.docker.com/). Docker eases installing, upgrading, starting and stopping ArchivesSpace. It also makes it easy to setup ArchivesSpace as a system service that starts automatically on every reboot.
8+
9+
If you prefer not to use Docker, another (more involved) way to get ArchivesSpace up and running is installing the latest [distribution `.zip` file](/getting_started/zip_distribution).
10+
11+
### System requirements
12+
13+
See [System Requirements](/getting_started/system_requirements).
14+
15+
### Software Dependencies
16+
17+
When using Docker, the only software dependency is [Docker](https://www.docker.com/) itself.
18+
19+
Follow the [instructions](https://docs.docker.com/get-started/get-docker/) to install the Docker engine.
20+
Optionally installing [Docker Desktop](https://www.docker.com/products/docker-desktop/) provides a graphical way to manage, start and stop your docker containers.
21+
22+
### Downloading the configuration package
23+
24+
To run ArchivesSpace with Docker, first download the ArchivesSpace docker configuration package of the latest release from [github](https://github.com/archivesspace/archivesspace/releases) (scroll down to the "Assets" section of the latest release page).
25+
26+
Unzipping the downloaded file will create an `archivespace-docker-vX.X.X` directory with the following contents:
27+
28+
```
29+
.
30+
├── config
31+
│   └── config.rb
32+
├── docker-compose.yml
33+
├── .env.docker.db
34+
├── .env.docker.prod
35+
└── plugins
36+
```
37+
38+
- The `config.rb` file contains the main configuration of ArchivesSpace.
39+
- `docker-compose.yml` contains all the information required by Docker to build and run ArchivesSpace
40+
- `.env.docker.db` contains the credentials used by archivespace to access its MySQL database. It is recommended to default root and user passwords to something safer.
41+
- `.env.docker.prod` contains the database connection URI which should also be updated accordingly after the database user password is updated.
42+
- The `plugins` directory is there to accommodate any [plugins](/customization/plugins/) you wish to install.
43+
44+
## Running
45+
46+
### Start
47+
48+
Open a terminal, change to the `archivespace-docker-vX.X.X` directory that contains the `docker-compose.yml` file and run:
49+
50+
```
51+
docker compose up --detach
52+
```
53+
54+
The first time you start ArchivesSpace with Docker, the container images will be downloaded and configuration steps such as database setup and solr index initialization will be performed automatically.
55+
It is expected that the whole process takes up to ten minutes or even more depending on the power of your machine and internet connection speed.
56+
57+
Starting with the `--detach` option allows closing the terminal without stoping ArchivesSpace. Viewing the logs of running ArchivesSpace containers is possible in [Docker Desktop](https://www.docker.com/products/docker-desktop/) or in a terminal with:
58+
59+
```
60+
docker compose logs --follow
61+
```
62+
63+
Watch the logs for the welcome message:
64+
65+
```
66+
2024-12-04 18:42:17 archivesspace | ************************************************************
67+
2024-12-04 18:42:17 archivesspace | Welcome to ArchivesSpace!
68+
2024-12-04 18:42:17 archivesspace | You can now point your browser to http://localhost:8080
69+
2024-12-04 18:42:17 archivesspace | ************************************************************
70+
```
71+
72+
You can then [login and verify](/getting_started/first_steps) that it is running correctly.
73+
74+
If you have also [Docker Desktop](https://www.docker.com/products/docker-desktop/) installed, you can use it to start, stop and manage the ArchivesSpace containers after they have been created for the first time. At the time of writing this, there is no way to call `docker compose` using Docker Desktop.
75+
76+
### Stop
77+
78+
You can stop running containers without removing them with the command:
79+
80+
```
81+
docker compose stop
82+
```
83+
84+
They can be started again with:
85+
86+
```
87+
docker compose start
88+
```

‎src/content/docs/getting_started/first_steps.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: First Steps
3+
---
4+
5+
Once it is ready, confirm that ArchivesSpace is running correctly by accessing the following URLs in your browser:
6+
7+
- http://localhost:8089/ -- the backend
8+
- http://localhost:8080/ -- the staff interface
9+
- http://localhost:8081/ -- the public interface
10+
- http://localhost:8082/ -- the OAI-PMH server
11+
- http://localhost:8090/ -- the Solr admin console
12+
13+
To start using the Staff interface application, log in using the administrator account:
14+
15+
- Username: `admin`
16+
- Password: `admin`
17+
18+
Then, you can create a new repository by selecting "System" -> "Manage repositories" at the top right hand side of the screen. From the "System" menu, you can perform a variety of administrative tasks,
19+
such as creating and modifying user accounts. **Be sure to change the "admin" user's password at this time.**

‎src/content/docs/getting_started/overview.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Overview
3+
---
4+
5+
you can use docker or the zip distribution

‎src/content/docs/getting_started/system_requirements.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: System requirements
3+
---
4+
5+
### Operating system
6+
7+
ArchivesSpace is known to operate well on Ubuntu Linux, Mac OS X, and Windows.
8+
9+
### Memory
10+
11+
At least 1024 MB RAM allocated to the application are required. We recommend using at least 2 GB for optimal performance.

‎src/content/docs/getting_started/zip_distribution.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: Running the zip distribution
3+
---
4+
5+
If you prefer not to [use Docker](/getting_started/docker.md), another way to get ArchivesSpace up and running is to download the latest distribution `.zip`
6+
file and use your own-managed Database and Solr services. This requires more effort to get all requirements in place, as explained below.
7+
8+
## System requirements
9+
10+
See [System Requirements](/getting_started/system_requirements)
11+
12+
## Software Dependencies
13+
14+
When using the zip distribution of ArchivesSpace, the following software dependencies are required:
15+
16+
### Java Runtime Environment
17+
18+
You will need to have Java installed on your machine. You can check your Java version by running the command:
19+
20+
java -version
21+
22+
We recommend using [OpenJDK](https://openjdk.org/projects/jdk/). The following table lists the supported Java versions for each version of ArchivesSpace:
23+
24+
| ArchivesSpace version | OpenJDK version |
25+
| --------------------- | --------------- |
26+
| ≤ v3.5.1 | 8 or 11 |
27+
| ≥ v4.0.0 | 11 or 17 |
28+
29+
If you are running an earlier version of java upgrade to one of the supported ones (not the newest one). If you are running a newer version of Java you should revert back to or force your machine to use a supported version.
30+
31+
### Solr
32+
33+
Up to ArchivesSpace v3.1.1, the zip file distribution includes an embedded Solr v4 instance, which is deprecated and not supported anymore.
34+
35+
ArchivesSpace v3.2.0 or above requires an external Solr instance. The table below summarizes the supported Solr versions for each ArchivesSpace version:
36+
37+
| ArchivesSpace version | External Solr version |
38+
| --------------------- | ------------------------- |
39+
| ≤ v3.1.1 | no external solr required |
40+
| v3.1.1 up to v3.5.1 | 8 (8.11) |
41+
| ≥ v4.0.0 | 9 (9.4.1) |
42+
43+
Each ArchivesSpace version is tested for compatibility with the corresponding Solr version listed in the table above, both during development and automated testing.
44+
45+
It may be possible to use ArchivesSpace with an older version of Solr. However in that case it is important to check the [release notes](https://github.com/archivesspace/archivesspace/releases)
46+
for any potential version compatibility issues.
47+
48+
**Note: the ArchivesSpace Program Team can only provide support for Solr deployments using the "officially" supported version with the standard configuration provided by
49+
the application. Everything else will be treated as "best effort" community-led support.**
50+
51+
See [Running with external Solr](/provisioning/solr) for more information on installing and upgrading Solr.
52+
53+
### Database
54+
55+
While the ArchivesSpace zip distribution does include an embedded database for demonstration purposes, 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.)
56+
57+
**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
58+
a production instance.**
59+
60+
All ArchivesSpace versions can run on MySQL version 5.x or 8.x. See [MySQL](/provisioning/mysql) for detailed instructions on setting up MySQL for ArchivesSpace.
61+
62+
## Downloading and Installing
63+
64+
Once you have Java, MySQL and Solr in place, you are ready to download and install ArchivesSpace. **Do not proceed until MySQL and Solr are running.** The latest version of the ArchivesSpace zip distribution (and all older ones) are available at: [https://github.com/archivesspace/archivesspace/releases](https://github.com/archivesspace/archivesspace/releases)
65+
66+
When you extract the `.zip` file, it will create a directory called `archivesspace`.
67+
68+
It is now time to download and install the [JDBC driver for MySQL](https://docs.archivesspace.org/provisioning/mysql/#download-mysql-connector).
69+
70+
### Start ArchivesSpace
71+
72+
To run the system, just execute the appropriate startup script for your platform. On Linux and OSX:
73+
74+
cd /path/to/archivesspace
75+
./archivesspace.sh
76+
77+
and for Windows:
78+
79+
cd \path\to\archivesspace
80+
archivesspace.bat
81+
82+
This will start ArchivesSpace running in foreground mode (so it will shut down when you close your terminal window). Log output will be written to the file `logs/archivesspace.out` (by default).
83+
84+
**Note:** If you're running Windows and you get an error message like `unable to resolve type 'size_t'` or `no such file to load -- bundler`,make sure that there are no spaces in any part of the
85+
path name in which the ArchivesSpace directory is located.
86+
87+
The first time it starts, the system will take a minute or so to start up. You can then [login and verify](/getting_started/first_steps) that it is running correctly.

0 commit comments

Comments
 (0)