LOCKSS System Manual
LOCKSS 2.0-beta2 System Manual
1. Introduction
1.1. LOCKSS Primer
1.1.1. What Is LOCKSS?
1.1.2. What Is New in LOCKSS 2.x?
1.2. Stack Components
1.2.1. Mandatory Stack Components
1.2.1.1. LOCKSS Repository Service
1.2.1.2. LOCKSS Configuration Service
1.2.1.3. LOCKSS Poller Service
1.2.1.4. PostgreSQL
1.2.2. Optional Stack Components
1.2.2.1. LOCKSS Crawler Service
1.2.2.2. LOCKSS Metadata Service
1.2.2.3. LOCKSS SOAP Compatibility Service
1.2.3. Web Replay Engines
1.2.3.1. ServeContent
1.2.3.2. Pywb
1.2.3.3. OpenWayback
1.2.4. Deprecated Stack Components
1.3. System Prerequisites
1.3.1. Host Prerequisites
1.3.1.1. CPU Prerequisites
1.3.1.2. Memory Prerequisites
1.3.1.3. Operating System Prerequisites
1.3.1.4. Linux Kernel Prerequisites
1.3.1.5. System Software Prerequisites
1.3.2. Storage Prerequisites
1.3.2.1. System Storage Prerequisites
1.3.2.2. Operating Storage Prerequisites
1.3.2.3. Content Storage Prerequisites
1.3.3. Miscellaneous Prerequisites
1.3.3.1. Networking Considerations
1.3.3.2. Configuration Management Considerations
2. Installing LOCKSS
2.1. Creating the
lockss
User and Group
2.1.1. Establishing a
root
Session
2.1.2. Invoking
adduser
2.2. Downloading the LOCKSS Installer
2.2.1. LOCKSS Installer Directory
2.2.2. Default LOCKSS Installer Directory
2.2.3. Running the LOCKSS Downloader
2.3. Running
install-lockss
2.3.1. Invoking
install-lockss
2.3.2. Checking System Prerequisites
2.3.3. Checking K3s Prerequisites
2.3.4. Configuring
iptables
for K3s
2.3.5. Configuring
firewalld
for K3s
2.3.6. Configuring
ufw
for K3s
2.3.7. Configuring CoreDNS for K3s
2.3.8. Installing K3s
2.3.9. Testing the K3s Node
2.3.10. Final Steps of
install-lockss
2.3.11. Checking the K3s Configuration
3. Upgrading LOCKSS
4. Configuring LOCKSS
4.1. Gathering Configuration Information
4.2. Invoking
configure-lockss
4.3. Kubernetes Settings
4.4. Network Settings
4.4.1. Hostname
4.4.2. IP Address
4.4.3. Initial UI Subnet
4.4.4. LCAP Port
4.4.5. Network Address Translation
4.5. Mail Settings
4.5.1. Mail Relay
4.5.2. Mail Relay Credentials
4.5.3. Administrator Email
4.6. Preservation Network Settings
4.6.1. Configuration URL
4.6.2. Configuration Proxy
4.6.3. Preservation Groups
4.7. Web User Interface Settings
4.7.1. Container Subnet
4.8. Storage Area Settings
4.8.1. Content Storage Area Settings
4.8.2. State Data Storage Area Settings
4.8.3. Log Storage Area Settings
4.8.4. Temporary Storage Area Settings
4.9. Database Settings
4.10. Stack Component Settings
4.10.1. Crawler Service Settings
4.10.2. Metadata Service Settings
4.10.3. SOAP Compatibility Service Settings
4.11. Web Replay Settings
4.11.1. Pywb Settings
4.11.2. OpenWayback Settings
4.12. Final Steps of
configure-lockss
5. Running LOCKSS
5.1. Starting LOCKSS
5.2. Stopping LOCKSS
5.3. Restarting LOCKSS
5.4. Removing a Configured LOCKSS Stack
5.5. Valid Component Identifiers
6. Using LOCKSS
6.1. Using the LOCKSS Configuration Service
6.1.1. Accessing the Web User Interface
6.1.2. Adding Archival Units
6.1.3. Configuring a Crawl Proxy
6.1.4. Managing Access to the Web User Interfaces
6.2. Using the LOCKSS Crawler Service
6.2.1. Accessing the Web User Interface
6.2.2. Monitoring Crawl Status in the System
6.2.3. Causing an Archival Unit to Crawl
6.2.4. Crawl Status Screen
6.2.4.1. Top-Level Crawl Information
6.2.4.2. Crawl Status Entry
6.3. Using the LOCKSS Poller Service
6.3.1. Accessing the Web User Interface
6.3.2. Requesting Polls
6.3.3. Monitoring Polling and Voting
6.4. Using the LOCKSS Metadata Extraction Service
6.4.1. Accessing the Web User Interface
6.4.2. Requesting Metadata Extraction
6.5. Using the LOCKSS Metadata Service
6.5.1. Accessing the Web User Interface
6.5.2. Requesting Metadata Information
6.6. Replaying Web Content with Pywb
6.6.1. Accessing the Pywb User Interface
6.6.2. Replaying a URL
6.6.3. Finding a URL From an AU to Replay
6.7. Replaying Web Content with OpenWayback
6.7.1. Accessing the OpenWayback User Interface
6.7.2. Replaying a URL
6.7.3. Finding a URL From an AU to Replay
6.8. Using the Kubernetes Dashboard
6.8.1. Installing the Kubernetes Dashboard
6.8.2. Accessing the Kubernetes Dashboard
6.8.3. Using the Kubernetes Dashboard UI
6.8.4. Updating the Kubernetes Dashboard
6.8.5. Removing the Kubernetes Dashboard
7. Troubleshooting LOCKSS
7.1. Known Issues
7.2. Troubleshooting
iptables
7.2.1. Switch iptables to legacy mode via Alternatives
7.2.2. Post-Installation Changes to
iptables
7.3. Troubleshooting
firewalld
7.3.1. Add 10.42.0.0/16 and 10.43.0.0/16 to firewalld's trusted zone
7.3.2. Post-Installation Changes to
firewalld
7.4. Troubleshooting
ufw
7.4.1. Allow traffic from 10.42.0.0/16 and 10.43.0.0/16 via ufw
7.4.2. Post-Installation Changes to
ufw
7.5. Troubleshooting CoreDNS
7.5.1. CoreDNS does not allow a loopback address to be given to Kubernetes pods as an upstream DNS server
7.5.2. Post-Installation Changes to DNS
7.6. Troubleshooting the K3s Installer
7.6.1. Enabling User Namespaces in RHEL 7 and CentOS 7
7.6.2. Installing
apparmor_parser
7.6.3. Failed to apply container_runtime_exec_t to /usr/local/bin/k3s
7.6.4. k3s-selinux requires container-selinux
7.7. Troubleshooting the K3s Configuration Checker
7.7.1. iptables should be older than v1.8.0, newer than v1.8.3, or in legacy mode
7.7.2. User namespaces disabled
7.7.3. apparmor enabled but apparmor_parser missing
7.7.4. cgroup hierarchy nonexistent
7.7.5. links: aux/iptables should link to iptables-detect.sh
7.7.6. swap should be disabled
7.7.7. CONFIG_INET_XFRM_MODE_TRANSPORT missing
7.8. Troubleshooting OverlayFS with XFS
7.8.1. Filesystem backing
/var/lib/rancher
is an XFS filesystem with
ftype=0
8. System Administration Tasks
8.1. Upgrading to Linux Kernel 5.4 or Later
8.2. Installing the
ip_tables
Loadable Kernel Module
8.3. Installing Curl
8.4. Installing Wget
8.5. Installing
tar
8.6. Installing
unzip
8.7. Operating System Updates
8.8. Resetting the System to a Blank State
9. Appendix
9.1. Security Advisories
9.2. Release Notes
9.2.1. LOCKSS 2.0.91-beta2
9.3. Software License
9.4. Operating Systems
9.4.1. Compatible Operating Systems
9.4.2. Unsuitable Operating Systems
9.5. Network Ports
9.5.1. LOCKSS 2.0-beta2 Port Changes
9.6. Frequently Asked Questions
9.7. Downloading the LOCKSS Installer using Git
9.8. Working with PostgreSQL
9.8.1. Changing the PostgreSQL Database Password
9.9. LCAP Over SSL
9.9.1. Generating Keystores
9.9.1.1. Interactive Tool
9.9.1.2. Command Line Tool
9.9.2. Installing the Keystores
Glossary
Index
Navigation
LOCKSS Program Web Site
LOCKSS Documentation Portal
LOCKSS Community Wiki
LOCKSS Community Discussions
LOCKSS System Manual
Index
Index
A
|
C
|
D
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
W
A
archival unit
archival unit identifier
artifact reindexing
AU
see archival unit
AUID
see archival unit identifier
C
Configuration Service
see LOCKSS Configuration Service
configure-lockss
,
[1]
confirmation
database
error condition
invocation
Kubernetes
mail
network
preparation
preservation network
stack components
storage areas
Web replay
Web user interface
container
container orchestration system
container stack
see stack
content storage
prerequisites
,
[1]
content storage area
configuration
CoreDNS
install-lockss
Crawler Service
see LOCKSS Crawler Service
Curl
,
[1]
,
[2]
,
[3]
D
Docker
Docker Hub
F
firewall
firewalld
install-lockss
G
Git
,
[1]
GitHub
,
[1]
,
[2]
I
id
install-lockss
CoreDNS
error condition
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
,
[6]
,
[7]
,
[8]
,
[9]
,
[10]
firewalld
invocation
iptables
K3s
K3s prerequisites
,
[1]
,
[2]
,
[3]
,
[4]
K3s testing
running on auto-pilot
running one phase
skipping phases
system prerequisites
ufw
iptables
install-lockss
K
K3s
check-config
configuration check
install-lockss
installation
installation prerequisites
,
[1]
,
[2]
,
[3]
,
[4]
testing
upgrade
K3s Configuration Checker
K3s data directory
K3s Installer
Kubernetes
L
LCAP
see LOCKSS Content Audit Protocol
Library Content Audit Protocol
see LOCKSS Content Audit Protocol
LOCKSS
LOCKSS Configuration Service
LOCKSS stack
LOCKSS Content Audit Protocol
LOCKSS Crawler Service
LOCKSS stack
LOCKSS Downloader
invocation
LOCKSS Installer
custom directory
custom version
installation
pre-inspection
LOCKSS Installer Directory
,
[1]
custom
default
LOCKSS Metadata Service
LOCKSS stack
LOCKSS network
LOCKSS plugin
LOCKSS Poller Service
LOCKSS stack
LOCKSS Program
LOCKSS Repository Service
LOCKSS stack
LOCKSS SOAP Compatibility Service
LOCKSS stack
LOCKSS stack
LOCKSS Configuration Service
LOCKSS Crawler Service
LOCKSS Metadata Service
LOCKSS Poller Service
LOCKSS Repository Service
LOCKSS SOAP Compatibility Service
OpenWayback
PostgreSQL
Pywb
restarting
ServeContent
starting
stopping
LOCKSS system
LOCKSS_INSTALLER_DIRECTORY
log storage area
configuration
M
Metadata Service
see LOCKSS Metadata Service
N
netfilter
nftables
O
OpenWayback
LOCKSS stack
operating storage
prerequisites
P
plugin
see LOCKSS plugin
Poller Service
see LOCKSS Poller Service
PostgreSQL
LOCKSS stack
Pywb
LOCKSS stack
R
Repository
see LOCKSS Repository Service
Repository Service
see LOCKSS Repository Service
restart-lockss
options
runuser
,
[1]
,
[2]
S
ServeContent
LOCKSS stack
SOAP Service
see LOCKSS SOAP Compatibility Service
software container
see container
stack
start-lockss
options
state data storage area
configuration
stop-lockss
options
,
[1]
symbol
LOCKSS_INSTALLER_DIRECTORY
system prerequisites
configuration management
content storage
CPU
host
Linux kernel
memory
miscellaneous prerequisites
networking considerations
operating storage
operating system
system software
system storage
system storage
prerequisites
T
temporary storage area
configuration
U
ufw
install-lockss
useradd
W
Web playback engine
see Web replay engine
Web replay engine
Wget
,
[1]
,
[2]
,
[3]
whoami
,
[1]
,
[2]