5. Running LOCKSS

Note

The commands in this section are all run as the lockss user, in the LOCKSS Installer Directory.

5.1. Starting LOCKSS

To start the LOCKSS stack, use the start-lockss command:

If necessary, navigate to the LOCKSS Installer Directory in a lockss shell, symbolically:

cd <LOCKSS_INSTALLER_DIRECTORY>
Run this command as lockss:
```
scripts/start-lockss
```

start-lockss accepts some options:

--services, -s SVCS: Start only the configured Stack Components in the semicolon-separated list of component identifiers SVCS. By default, the script applies to all configured stack components. See Valid Component Identifiers.
--update, -u: Force an update of the containers of the LOCKSS stack from Docker Hub, if applicable, before proceeding. This may take several minutes depending on the download speed of the host system.
--wait, -w: Wait for an internal signal from the system that the its components are initialized. (Currently this internal signal comes from the LOCKSS Poller Service.)

Additional options are available; use --help/-h to see a help message.

5.2. Stopping LOCKSS

To stop the LOCKSS stack, use the stop-lockss command:

If necessary, navigate to the LOCKSS Installer Directory in a lockss shell, symbolically:

cd <LOCKSS_INSTALLER_DIRECTORY>
Run this command as lockss:
```
scripts/stop-lockss
```

stop-lockss accepts the -s, --services SVCS option. Its argument is a semicolon-separated list that indicates to stop only those configured stack components. See Valid Component Identifiers.

5.3. Restarting LOCKSS

To restart a running LOCKSS stack, use the restart-lockss command:

If necessary, navigate to the LOCKSS Installer Directory in a lockss shell, symbolically:

cd <LOCKSS_INSTALLER_DIRECTORY>
Run this command as lockss:
```
scripts/restart-lockss
```

restart-lockss accepts the same options as start-lockss (see here).

In particular, restart-lockss accepts the -s, --services SVCS option. Its argument is a semicolon-separated list that indicates to restart only the given configured stack components (by default, all components are restarted). See Valid Component Identifiers.

5.4. Removing a Configured LOCKSS Stack

To remove all configurations, volumes and networks configured by the LOCKSS system in Kubernetes, run scripts/uninstall-lockss. This will not remove files from the persistent store.

5.5. Valid Component Identifiers

start-lockss, restart-lockss, and stop-lockss all accept the -s, --services SVCS option, which accepts as its argument a semicolon-separated list of component identifiers, to indicate which configured Stack Components the command applies to. By default, the command applies to all configured components.

The valid stack component identifiers are:

Component identifier	Component
`configuration`, `config`, `cfg`	LOCKSS Configuration Service
`crawler`, `crawl`	LOCKSS Crawler Service
`metadata`, `md`	LOCKSS Metadata Service
`openwayback`, `openwb`, `owb`	OpenWayback
`poller`, `poll`, `pol`	LOCKSS Poller Service
`postgresql`, `postgres`, `pgsql`	PostgreSQL
`pywb`	Pywb
`repository`, `repo`	LOCKSS Repository Service
`soap`	LOCKSS SOAP Compatibility Service