LOCKSS System Manual Logo

LOCKSS 2.0-alpha7 System Manual

  • 1. Introduction
    • 1.1. System Prerequisites
      • 1.1.1. Host
      • 1.1.2. CPU
      • 1.1.3. Memory
      • 1.1.4. Storage
        • 1.1.4.1. Network-Attached Storage
    • 1.2. Operating System
  • 2. Upgrading the LOCKSS System
    • 2.1. Stop the LOCKSS System
    • 2.2. Update the LOCKSS Installer
    • 2.3. Run the Upgrade Script
    • 2.4. Re-run the Configure Script
    • 2.5. Start LOCKSS 2.0-alpha7
  • 3. Installing the LOCKSS System
    • 3.1. Creating the lockss User
    • 3.2. Downloading the LOCKSS Installer
      • 3.2.1. LOCKSS Installer Directory
      • 3.2.2. Default LOCKSS Installer Directory
      • 3.2.3. Running the LOCKSS Downloader
    • 3.3. Running the LOCKSS Installer
      • 3.3.1. Invoking the LOCKSS Installer
      • 3.3.2. Checking K3s Prerequisites
      • 3.3.3. Checking the System User and Group
      • 3.3.4. Configuring iptables for K3s
      • 3.3.5. Configuring firewalld for K3s
      • 3.3.6. Configuring ufw for K3s
      • 3.3.7. Configuring CoreDNS for K3s
      • 3.3.8. Installing K3s
      • 3.3.9. Testing the K3s Node
      • 3.3.10. Completion of the LOCKSS Installation Process
      • 3.3.11. Checking the K3s Configuration
  • 4. Configuring the LOCKSS System
    • 4.1. Before Invoking configure-lockss
    • 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. Network Address Translation
      • 4.4.4. Initial UI Subnet
      • 4.4.5. Container Subnet
      • 4.4.6. LCAP Port
    • 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. Storage Areas
      • 4.7.1. State Data Storage Area
      • 4.7.2. Content Storage Areas
      • 4.7.3. Log Storage Area
      • 4.7.4. Temporary Storage Area
    • 4.8. Web User Interface Settings
    • 4.9. Database Settings
      • 4.9.1. PostgreSQL
        • 4.9.1.1. Embedded PostgreSQL Database
        • 4.9.1.2. External PostgreSQL Database
      • 4.9.2. Solr
        • 4.9.2.1. Embedded Solr Database
        • 4.9.2.2. External Solr Database
    • 4.10. LOCKSS Services
      • 4.10.1. Crawler Service
      • 4.10.2. Metadata Query Service
      • 4.10.3. Metadata Extraction Service
      • 4.10.4. SOAP Compatibility Service
    • 4.11. Web Replay Settings
      • 4.11.1. Pywb
      • 4.11.2. OpenWayback
    • 4.12. Final Steps
  • 5. Running the LOCKSS System
    • 5.1. Starting the LOCKSS System
    • 5.2. Shutting down the LOCKSS System
    • 5.3. Restarting a Running LOCKSS System
    • 5.4. Removing a Configured LOCKSS System
  • 6. Using the LOCKSS System
    • 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 the LOCKSS System
    • 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. Running Commands as root
      • 8.1.1. Running Commands as root With sudo
      • 8.1.2. Running Commands Directly as root
    • 8.2. Running Commands as a Privileged User
    • 8.3. Running Commands as the lockss User
      • 8.3.1. Running Commands as lockss With sudo
      • 8.3.2. Running Commands as lockss With su
    • 8.4. Operating System Updates
    • 8.5. Installing Curl
    • 8.6. Installing HTTPie
    • 8.7. Installing Wget
    • 8.8. Resetting the System to a Blank State
  • 9. Appendix
    • 9.1. Security Advisories
      • 9.1.1. CVE-2022-39135
    • 9.2. Release Notes
      • 9.2.1. LOCKSS 2.0.72-alpha7
      • 9.2.2. LOCKSS 2.0.71-alpha7
    • 9.3. Frequently Asked Questions
    • 9.4. Software License
    • 9.5. Network Ports
    • 9.6. Downloading the LOCKSS Installer using git
    • 9.7. Working with PostgreSQL
      • 9.7.1. Changing the PostgreSQL Database Password
    • 9.8. LCAP Over SSL
      • 9.8.1. Generating Keystores
        • 9.8.1.1. Command Line Tool
        • 9.8.1.2. Interactive Tool
      • 9.8.2. Installing the Keystores

Navigation

  • LOCKSS Web Site
  • LOCKSS Documentation Portal
  • LOCKSS Community Wiki
  • LOCKSS Community Discussions
LOCKSS System Manual
  • Search

© Copyright 2000-2023, LOCKSS Program.

Built with Sphinx using a theme provided by Read the Docs.