From 53e30ea2fdd157b5e238c80ecc4539a8848e94b8 Mon Sep 17 00:00:00 2001 From: Douglas Cerna Date: Tue, 2 Apr 2024 10:10:32 -0600 Subject: [PATCH] AM 1.16.0 + SS 0.22.0 * Update stable version references * Update installation instructions --- .../installation/install-rocky.rst | 6 +- .../installation/install-ubuntu.rst | 78 +++++++++---------- .../installation/scripts/am-jammy-deb.sh | 17 ++-- .../installation/scripts/am-rocky-rpm.sh | 4 +- .../upgrading/upgrading.rst | 6 +- admin-manual/security/security.rst | 12 +-- conf.py | 8 +- style_guide.md | 6 +- 8 files changed, 65 insertions(+), 72 deletions(-) diff --git a/admin-manual/installation-setup/installation/install-rocky.rst b/admin-manual/installation-setup/installation/install-rocky.rst index 76497561..bbe4e2a7 100644 --- a/admin-manual/installation-setup/installation/install-rocky.rst +++ b/admin-manual/installation-setup/installation/install-rocky.rst @@ -255,8 +255,8 @@ the configuration of your new server. :ref:`Back to the top ` -.. _`Dashboard install README`: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/dashboard/install/README.md -.. _`MCPClient install README`: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/MCPClient/install/README.md -.. _`MCPServer install README`: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/MCPServer/install/README.md +.. _`Dashboard install README`: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/dashboard/install/README.md +.. _`MCPClient install README`: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/MCPClient/install/README.md +.. _`MCPServer install README`: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/MCPServer/install/README.md .. _`known issue`: https://github.com/artefactual/archivematica-storage-service/issues/312 .. _`Sword API`: https://wiki.archivematica.org/Sword_API diff --git a/admin-manual/installation-setup/installation/install-ubuntu.rst b/admin-manual/installation-setup/installation/install-ubuntu.rst index bad9d8c6..c4d20732 100644 --- a/admin-manual/installation-setup/installation/install-ubuntu.rst +++ b/admin-manual/installation-setup/installation/install-ubuntu.rst @@ -26,7 +26,7 @@ Ubuntu 22.04 (Jammy) installation instructions .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 12-15 + :lines: 15-18 #. Add Elasticsearch package source (optional). Elasticsearch comes from its own package repository. @@ -37,20 +37,20 @@ Ubuntu 22.04 (Jammy) installation instructions .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 17-18 + :lines: 20-21 #. Update to the most recent OS release. This step will also fetch a list of the software from the package repositories you just added to your system. .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 20-21 + :lines: 23-24 #. Install some needed packages .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 23 + :lines: 26 #. Install Elasticsearch (optional) @@ -59,26 +59,21 @@ Ubuntu 22.04 (Jammy) installation instructions .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 24 + :lines: 27 -#. Now that MySQL is up and running, create the Storage Service database and - set up the expected credentials. +#. Now that MySQL is up and running, install the Storage Service. You will be + prompted to create a password for its database. If necessary, the password + can be changed after the installation is complete. .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 26-28 - -#. Install the Storage Service package. - - .. literalinclude:: scripts/am-jammy-deb.sh - :language: bash - :lines: 30 + :lines: 29 #. Configure the Storage Service. .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 32-33 + :lines: 31-32 #. Install the Archivematica packages. The order of installation is important - the archivematica-mcp-server package must be installed before the dashboard @@ -90,13 +85,12 @@ Ubuntu 22.04 (Jammy) installation instructions database used by Archivematica. Depending on the version of MySQL that is installed, the interfaces that you see may differ slightly. - When you are prompted to create a password for the archivematica-mcp-server, - you must use ``demo`` as the password during the install process. The - password can be changed after the installation is complete. + You will be prompted to create a password for the database. If necessary, + the password can be changed after the installation is complete. .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 35-37 + :lines: 34-37 #. Configure the Archivematica components (optional). There are a number of environment variables that Archivematica recognizes which can be used to @@ -117,48 +111,48 @@ Ubuntu 22.04 (Jammy) installation instructions #. Configure the dashboard. - .. literalinclude:: scripts/am-jammy-deb.sh - :language: bash - :lines: 39 + .. literalinclude:: scripts/am-jammy-deb.sh + :language: bash + :lines: 38 #. Start Elasticsearch (optional). - .. note:: Skip this step if you are planning to run Archivematica in indexless - mode (without Elasticsearch). + .. note:: Skip this step if you are planning to run Archivematica in indexless + mode (without Elasticsearch). - .. literalinclude:: scripts/am-jammy-deb.sh + .. literalinclude:: scripts/am-jammy-deb.sh :language: bash - :lines: 41-43 + :lines: 40-42 #. Start the remaining services - .. literalinclude:: scripts/am-jammy-deb.sh - :language: bash - :lines: 45-55 + .. literalinclude:: scripts/am-jammy-deb.sh + :language: bash + :lines: 44-54 - If you have trouble with the gearman or clamav command try restarting it: + If you have trouble with the gearman or clamav command try restarting it: - .. code:: bash + .. code:: bash sudo service gearman-job-server restart sudo service clamav-daemon restart #. Configure your firewall (if applicable) - On Ubuntu, the default firewall configuration tool is ufw (Uncomplicated - Firewall). To see the firewall status, enter: + On Ubuntu, the default firewall configuration tool is ufw (Uncomplicated + Firewall). To see the firewall status, enter: - .. code:: bash + .. code:: bash sudo ufw status - If ufw is active, you must ensure that it is not blocking the ports used by - the dashboard and the Storage Service, i.e., 80 and 8000. + If ufw is active, you must ensure that it is not blocking the ports used by + the dashboard and the Storage Service, i.e., 80 and 8000. - .. literalinclude:: scripts/am-jammy-deb.sh - :language: bash - :lines: 57-60 + .. literalinclude:: scripts/am-jammy-deb.sh + :language: bash + :lines: 57-59 #. Complete :ref:`Post Install Configuration `. @@ -234,7 +228,7 @@ the configuration of your new server. .. _`Sword API`: https://wiki.archivematica.org/Sword_API .. _`known issue with pip`: https://bugs.launchpad.net/ubuntu/+source/python-pip/+bug/1658844 -.. _`Dashboard install README`: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/dashboard/install/README.md -.. _`MCPClient install README`: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/MCPClient/install/README.md -.. _`MCPServer install README`: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/MCPServer/install/README.md +.. _`Dashboard install README`: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/dashboard/install/README.md +.. _`MCPClient install README`: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/MCPClient/install/README.md +.. _`MCPServer install README`: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/MCPServer/install/README.md .. _`Archivematica user forum`: https://groups.google.com/forum/#!forum/archivematica diff --git a/admin-manual/installation-setup/installation/scripts/am-jammy-deb.sh b/admin-manual/installation-setup/installation/scripts/am-jammy-deb.sh index d42e1745..f1e50ba2 100644 --- a/admin-manual/installation-setup/installation/scripts/am-jammy-deb.sh +++ b/admin-manual/installation-setup/installation/scripts/am-jammy-deb.sh @@ -5,14 +5,17 @@ set -euxo pipefail export DEBIAN_FRONTEND=noninteractive sudo debconf-set-selections <<< "postfix postfix/mailname string your.hostname.com" sudo debconf-set-selections <<< "postfix postfix/main_mailer_type string 'Internet Site'" +sudo debconf-set-selections <<< "archivematica-storage-service archivematica-storage-service/dbconfig-install boolean true" +sudo debconf-set-selections <<< "archivematica-storage-service archivematica-storage-service/mysql/app-pass password demo-ss" +sudo debconf-set-selections <<< "archivematica-storage-service archivematica-storage-service/app-password-confirm password demo-ss" sudo debconf-set-selections <<< "archivematica-mcp-server archivematica-mcp-server/dbconfig-install boolean true" -sudo debconf-set-selections <<< "archivematica-mcp-server archivematica-mcp-server/mysql/app-pass password demo" -sudo debconf-set-selections <<< "archivematica-mcp-server archivematica-mcp-server/app-password-confirm password demo" +sudo debconf-set-selections <<< "archivematica-mcp-server archivematica-mcp-server/mysql/app-pass password demo-am" +sudo debconf-set-selections <<< "archivematica-mcp-server archivematica-mcp-server/app-password-confirm password demo-am" -curl -fsSL https://packages.archivematica.org/1.15.x/key.asc | sudo gpg --dearmor -o /etc/apt/keyrings/archivematica-1.15.x.gpg +curl -fsSL https://packages.archivematica.org/1.16.x/key.asc | sudo gpg --dearmor -o /etc/apt/keyrings/archivematica-1.16.x.gpg -sudo sh -c 'echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/archivematica-1.15.x.gpg] http://packages.archivematica.org/1.15.x/ubuntu jammy main" > /etc/apt/sources.list.d/archivematica.list' -sudo sh -c 'echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/archivematica-1.15.x.gpg] http://packages.archivematica.org/1.15.x/ubuntu-externals jammy main" > /etc/apt/sources.list.d/archivematica-externals.list' +sudo sh -c 'echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/archivematica-1.16.x.gpg] http://packages.archivematica.org/1.16.x/ubuntu jammy main" > /etc/apt/sources.list.d/archivematica.list' +sudo sh -c 'echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/archivematica-1.16.x.gpg] http://packages.archivematica.org/1.16.x/ubuntu-externals jammy main" > /etc/apt/sources.list.d/archivematica-externals.list' curl -fsSL https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo gpg --dearmor -o /etc/apt/keyrings/elasticsearch-6.x.gpg echo "deb [signed-by=/etc/apt/keyrings/elasticsearch-6.x.gpg] https://artifacts.elastic.co/packages/6.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-6.x.list @@ -23,10 +26,6 @@ sudo apt-get -y upgrade sudo apt-get install -y openjdk-8-jre-headless mysql-server sudo apt-get install -y elasticsearch -sudo mysql -e "DROP DATABASE IF EXISTS SS; CREATE DATABASE SS CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci;" -sudo mysql -e "CREATE USER 'archivematica'@'localhost' IDENTIFIED BY 'demo';" -sudo mysql -e "GRANT ALL ON SS.* TO 'archivematica'@'localhost';" - sudo apt-get install -y archivematica-storage-service sudo rm -f /etc/nginx/sites-enabled/default diff --git a/admin-manual/installation-setup/installation/scripts/am-rocky-rpm.sh b/admin-manual/installation-setup/installation/scripts/am-rocky-rpm.sh index 99cb61bd..62bd1ba0 100644 --- a/admin-manual/installation-setup/installation/scripts/am-rocky-rpm.sh +++ b/admin-manual/installation-setup/installation/scripts/am-rocky-rpm.sh @@ -31,7 +31,7 @@ EOF' sudo -u root bash -c 'cat << EOF > /etc/yum.repos.d/archivematica.repo [archivematica] name=archivematica -baseurl=https://packages.archivematica.org/1.15.x/rocky9/ +baseurl=https://packages.archivematica.org/1.16.x/rocky9/ gpgcheck=1 gpgkey=https://packages.archivematica.org/GPG-KEY-archivematica-sha512 enabled=1 @@ -40,7 +40,7 @@ EOF' sudo -u root bash -c 'cat << EOF > /etc/yum.repos.d/archivematica-extras.repo [archivematica-extras] name=archivematica-extras -baseurl=https://packages.archivematica.org/1.15.x/rocky9-extras +baseurl=https://packages.archivematica.org/1.16.x/rocky9-extras gpgcheck=1 gpgkey=https://packages.archivematica.org/GPG-KEY-archivematica-sha512 enabled=1 diff --git a/admin-manual/installation-setup/upgrading/upgrading.rst b/admin-manual/installation-setup/upgrading/upgrading.rst index 3ae37c17..938a42e7 100644 --- a/admin-manual/installation-setup/upgrading/upgrading.rst +++ b/admin-manual/installation-setup/upgrading/upgrading.rst @@ -131,8 +131,8 @@ Upgrade on Ubuntu packages .. code:: bash - echo 'deb [arch=amd64] http://packages.archivematica.org/1.15.x/ubuntu jammy main' >> /etc/apt/sources.list - echo 'deb [arch=amd64] http://packages.archivematica.org/1.15.x/ubuntu-externals jammy main' >> /etc/apt/sources.list + echo 'deb [arch=amd64] http://packages.archivematica.org/1.16.x/ubuntu jammy main' >> /etc/apt/sources.list + echo 'deb [arch=amd64] http://packages.archivematica.org/1.16.x/ubuntu-externals jammy main' >> /etc/apt/sources.list Optionally you can remove the lines referencing packages.archivematica.org/|previous_version|.x from /etc/apt/sources.list. @@ -183,7 +183,7 @@ Upgrade on Rocky Linux/Red Hat packages .. code:: bash - sudo sed -i 's/1.14.x/1.15.x/g' /etc/yum.repos.d/archivematica* + sudo sed -i 's/1.15.x/1.16.x/g' /etc/yum.repos.d/archivematica* #. Remove the current installed version of ghostscript: diff --git a/admin-manual/security/security.rst b/admin-manual/security/security.rst index c27c25ab..2747b62e 100644 --- a/admin-manual/security/security.rst +++ b/admin-manual/security/security.rst @@ -468,9 +468,9 @@ This will create a new :file:`/etc/ssl/certs/ca-certificates.crt` file. .. _django-auth-infra: https://docs.djangoproject.com/en/3.2/topics/auth/customizing/#authentication-backends .. _am-gh-issues: https://github.com/artefactual/archivematica/issues .. _am-google-groups: https://groups.google.com/forum/#!forum/archivematica -.. _am-dashboard-config: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/dashboard/install/README.md -.. _am-ldap-auth-mod: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/dashboard/src/settings/components/ldap_auth.py -.. _am-shib-auth-mod: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/dashboard/src/settings/components/shibboleth_auth.py +.. _am-dashboard-config: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/dashboard/install/README.md +.. _am-ldap-auth-mod: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/dashboard/src/settings/components/ldap_auth.py +.. _am-shib-auth-mod: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/dashboard/src/settings/components/shibboleth_auth.py .. _ldap: https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol .. _shibboleth: https://www.shibboleth.net/ .. _oidc: https://openid.net/connect/ @@ -479,10 +479,10 @@ This will create a new :file:`/etc/ssl/certs/ca-certificates.crt` file. .. _requests: https://requests.readthedocs.io/en/master/ .. _requests-cas: https://requests.readthedocs.io/en/master/user/advanced/#ca-certificates .. _elasticsearch-security-external: https://www.elastic.co/guide/en/x-pack/current/elasticsearch-security.html -.. _ss-config: https://github.com/artefactual/archivematica-storage-service/blob/stable/0.21.x/install/README.md +.. _ss-config: https://github.com/artefactual/archivematica-storage-service/blob/stable/0.22.x/install/README.md .. _mozilla-django-oidc-docs: https://mozilla-django-oidc.readthedocs.io/en/stable/ .. _django-csp-docs: https://django-csp.readthedocs.io/en/latest/ .. _django-https-settings: https://docs.djangoproject.com/en/3.2/topics/security/#ssl-https .. _django-session-settings: https://docs.djangoproject.com/en/3.2/topics/http/sessions/#settings -.. _am-prod-settings: https://github.com/artefactual/archivematica/blob/stable/1.15.x/src/dashboard/src/settings/production.py -.. _ss-prod-settings: https://github.com/artefactual/archivematica-storage-service/blob/stable/0.21.x/storage_service/storage_service/settings/production.py +.. _am-prod-settings: https://github.com/artefactual/archivematica/blob/stable/1.16.x/src/dashboard/src/settings/production.py +.. _ss-prod-settings: https://github.com/artefactual/archivematica-storage-service/blob/stable/0.22.x/storage_service/storage_service/settings/production.py diff --git a/conf.py b/conf.py index 474b6c50..c523ff19 100644 --- a/conf.py +++ b/conf.py @@ -76,13 +76,13 @@ # built documents. # # The short X.Y version. -version = '1.15' +version = '1.16' # The full version, including alpha/beta/rc tags. -release = '1.15.1' +release = '1.16.0' rst_epilog = """ -.. |previous_version| replace:: 1.14 -.. |previous_release| replace:: 1.14.1 +.. |previous_version| replace:: 1.15 +.. |previous_release| replace:: 1.15.1 """ # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/style_guide.md b/style_guide.md index f2c23f4e..2ea2ceac 100644 --- a/style_guide.md +++ b/style_guide.md @@ -568,9 +568,9 @@ Short, simple scripts can be added as code blocks using the `code` directive. ```rst .. code:: bash - sudo wget -O - https://packages.archivematica.org/1.15.x/key.asc | sudo apt-key add - - sudo sh -c 'echo "deb [arch=amd64] http://packages.archivematica.org/1.15.x/ubuntu jammy main" >> /etc/apt/sources.list' - sudo sh -c 'echo "deb [arch=amd64] http://packages.archivematica.org/1.15.x/ubuntu-externals jammy main" >> /etc/apt/sources.list' + sudo wget -O - https://packages.archivematica.org/1.16.x/key.asc | sudo apt-key add - + sudo sh -c 'echo "deb [arch=amd64] http://packages.archivematica.org/1.16.x/ubuntu jammy main" >> /etc/apt/sources.list' + sudo sh -c 'echo "deb [arch=amd64] http://packages.archivematica.org/1.16.x/ubuntu-externals jammy main" >> /etc/apt/sources.list' ``` For longer scripts, or scripts that will be referenced on multiple pages, you