### Initialize Pslink Configuration and Database

Source: https://github.com/enaut/pslink/blob/main/README.md

Navigates to the Pslink installation directory and, as the 'pslink' user, generates the initial environment configuration file, migrates the database, and creates an administrative user.

```bash
cd /opt/pslink
sudo -u pslink /opt/pslink/pslink generate-env
sudo -u pslink /opt/pslink/pslink migrate-database
sudo -u pslink /opt/pslink/pslink create-admin
```

--------------------------------

### Start Pslink Server

Source: https://github.com/enaut/pslink/blob/main/README.md

Initiates the Pslink application server process. This command starts the core functionality of the URL shortener.

```bash
pslink runserver
```

--------------------------------

### Enable and Start Pslink Systemd Service

Source: https://github.com/enaut/pslink/blob/main/README.md

Enables the Pslink systemd service to automatically start on system boot and immediately starts the service for the current session.

```bash
sudo systemctl enable --now pslink
```

--------------------------------

### Start Pslink Web Server

Source: https://github.com/enaut/pslink/blob/main/README.md

This command launches the Pslink web service. It assumes that the environment file is configured, the database is migrated, and an admin user is created. After execution, the application should be accessible via a web browser at the configured URL, typically `http://localhost/app/`.

```bash
pslink runserver
```

--------------------------------

### Run Pslink Container with Demo Data

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Starts the Pslink server in a detached container with demo data. This setup is for quick testing, as data will not persist across restarts. Access the application via http://localhost:8080/app/.

```bash
podman run -d --name pslink_container \
  -p 8080:8080 \
  ghcr.io/enaut/pslink:latest
```

--------------------------------

### Install Pslink Binary from Release

Source: https://github.com/enaut/pslink/blob/main/README.md

These commands download and extract the latest Pslink binary bundle for Linux x86_64 from GitHub. After extraction, the `pslink` executable can be run directly. It's recommended to adjust the system PATH or create an alias for easier access.

```bash
# mkdir -p /opt/pslink
# cd /opt/pslink
# wget https://github.com/enaut/pslink/releases/latest/download/pslink-linux-x86_64-bundle.tgz
# tar -xf pslink-linux-x86_64-bundle.tgz
# /opt/pslink/pslink help
```

--------------------------------

### Pslink Systemd Service Configuration

Source: https://github.com/enaut/pslink/blob/main/README.md

An example systemd unit file for running Pslink as a background service. It defines the service's description, dependencies, user, group, environment variables, security hardening options, working directory, and the command to execute.

```systemd
cat /etc/systemd/system/pslink.service
[Unit]
Description=Pslink the Urlshortener
Documentation=https://github.com/enaut/Pslink
Wants=network.target
After=network.target

[Service]
User=pslink
Group=pslink
EnvironmentFile=-/opt/pslink/.env

ProtectHome=true
ProtectSystem=full
PrivateDevices=true
NoNewPrivileges=true
PrivateTmp=true
InaccessibleDirectories=/root /sys /srv /media -/lost+found
ReadWriteDirectories=/opt/pslink
WorkingDirectory=/opt/pslink
ExecStart=/opt/pslink/pslink runserver

[Install]
WantedBy=multi-user.target
```

--------------------------------

### Start Pslink Container for Production

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Starts the Pslink server in a detached container with persistent database and environment files, configured for production deployment. This command utilizes the pre-configured `.env` and `links.db` files.

```bash
podman run --replace -d --name pslink_container \
  -v ./links.db:/app/links.db:Z \
  -v ./.env:/app/.env:Z \
  -p 8080:8080 \
  ghcr.io/enaut/pslink:latest
```

--------------------------------

### Run Pslink Database Migration

Source: https://github.com/enaut/pslink/blob/main/README.md

Executes the database migration command for Pslink, updating the database schema to the latest version. This is typically run after updating the Pslink binary or during initial setup.

```bash
pslink migrate-database
```

--------------------------------

### Build pslink Container Image using Podman

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

This command builds the pslink container image from the current project root directory. It tags the resulting image as 'pslink:latest'. The instructions note that 'podman' can be interchanged with 'docker' based on the user's installed container runtime.

```bash
# Using Podman
podman build -t pslink:latest .
```

--------------------------------

### Create Pslink Admin User

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Executes the `create-admin` command inside the running Pslink container to set up an administrative user. This is a crucial step for securing and managing the Pslink instance after initial setup.

```bash
podman exec -it pslink_container /app/pslink create-admin
```

--------------------------------

### Disable Pslink Demo Mode

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Modifies the `.env` file to change the `DEMO` environment variable from `true` to `false`. This action disables the demo warning hint, typically performed after the initial setup for a production environment.

```bash
sed -i 's/DEMO="true"/DEMO="false"/' .env
```

--------------------------------

### Generate Pslink Environment Configuration File

Source: https://github.com/enaut/pslink/blob/main/README.md

This command creates a `.env` file in the current directory with default Pslink settings. Users should edit this file to customize their installation. While parameters can be provided via command line or environment variables, `PSLINK_SECRET` should ideally be set in the `.env` file for security.

```bash
pslink generate-env
```

--------------------------------

### Pslink Command Line Interface (CLI) Reference

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Detailed reference for the `pslink` command-line application, including available subcommands and global options. This output describes how to interact with the Pslink server for various administrative and operational tasks, such as running the server, creating users, or managing configuration.

```APIDOC
$ podman exec -it pslink_container /app/pslink --help
Usage: pslink [OPTIONS] [COMMAND]

Commands:
  runserver         Run the server
  create-admin      Create an admin user.
  generate-env      Generate an .env file template using default settings and exit
  migrate-database  Apply any pending migrations and exit
  help              Print this message or the help of the given subcommand(s)

Options:
      --db <database>                  The path of the sqlite database [env: PSLINK_DATABASE=/app/links.db] [default: ./links.db]
  -p, --port <port>                    The port the pslink service will run on [env: PSLINK_PORT=8080]
  -u, --public-url <public_url>        The host url or the page that will be part of the short urls. [env: PSLINK_PUBLIC_URL=localhost:8080] [default: 127.0.0.1:8080]
  -e, --empty-url <empty_forward_url>  The the url that / will redirect to. Usually your homepage. [env: PSLINK_EMPTY_FORWARD_URL=https://github.com/enaut/pslink] [default: https://github.com/enaut/pslink]
  -b, --brand-name <brand_name>        The Brandname that will apper in various places. [env: PSLINK_BRAND_NAME=Pslink] [default: Pslink]
  -i, --hostip <internal_ip>           The host (ip) that will run the pslink service [env: PSLINK_IP=localhost]
      --demo <demo>                    The host (ip) that will run the pslink service [env: DEMO=]
  -t, --protocol <protocol>            The protocol that is used in the qr-codes (http results in slightly smaller codes in some cases) [env: PSLINK_PROTOCOL=http] [default: http] [possible values: http, https]
      --secret <secret>                The secret that is used to encrypt the password database keep this as inaccessible as possible. As command line parameters are visible to all users it is not wise to use this as a command line parameter but rather as an environment variable. [env: PSLINK_SECRET=Slsgohetö<fgHSGHTRZAERTCNVbfoadhfgrziopüümbn,.] [default: ]
  -h, --help                           Print help
  -V, --version                        Print version
```

--------------------------------

### Execute Pslink Help Command in Container

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Shows how to execute the `pslink --help` command inside a running container. This command provides an overview of the Pslink application's available CLI arguments, commands, and options.

```bash
podman exec -it\
  ghcr.io/enaut/pslink:latest /app/pslink --help
```

--------------------------------

### Display Pslink Help Options

Source: https://github.com/enaut/pslink/blob/main/README.md

Shows a list of available commands and options for the Pslink application, providing guidance on its usage.

```bash
pslink help
```

--------------------------------

### Access Pslink Command Line Help

Source: https://github.com/enaut/pslink/blob/main/README.md

This command displays the help documentation for the Pslink binary, providing information on available commands and options. It's useful for understanding additional configuration parameters and functionalities.

```bash
pslink help
```

--------------------------------

### Create Empty Pslink Data Files

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Creates empty `.env` and `links.db` files. These files will serve as placeholders for mounting into the Pslink container, ensuring persistent storage of configuration and the application database.

```bash
touch .env links.db
```

--------------------------------

### Run Pslink Containerized with Podman/Docker

Source: https://github.com/enaut/pslink/blob/main/README.md

This command launches the Pslink service in demo mode using Podman or Docker. In demo mode, the database is reset on container restart. For production use, persistent storage for the `.env` file and `links.db` SQLite database is required.

```bash
podman run ghcr.io/enaut/pslink:latest
```

--------------------------------

### Migrate Pslink Database

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Applies any pending database migrations to the `links.db` file using the Pslink container. This step ensures the database schema is up-to-date and ready for production use.

```bash
podman run --replace -it --name  pslink_container \
  -v ./links.db:/app/links.db:Z \
  -v ./.env:/app/.env:Z \
  ghcr.io/enaut/pslink:latest /app/pslink migrate-database
```

--------------------------------

### Build Pslink from Source with Cargo

Source: https://github.com/enaut/pslink/blob/main/README.md

These commands build the Pslink web application from its source code using Cargo and Dioxus CLI. This process requires an internet connection to download dependencies. Upon successful compilation, the `server` binary (renamed to `pslink` in releases) will be located in the specified target directory.

```bash
cargo install dioxus-cli
dx bundle --release --package web
```

--------------------------------

### Generate Pslink Environment File

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Runs the Pslink container in interactive mode to generate a default `.env` file template. This command initializes the environment configuration for the Pslink application, populating the previously created empty `.env` file.

```bash
podman run -it --name pslink_container \
  -v ./links.db:/app/links.db:Z \
  -v ./.env:/app/.env:Z \
  ghcr.io/enaut/pslink:latest /app/pslink generate-env
```

--------------------------------

### Create Dedicated Pslink User

Source: https://github.com/enaut/pslink/blob/main/README.md

Creates a new system user named 'pslink' with its home directory set to '/opt/pslink'. This user is intended to run the Pslink service for enhanced security and isolation.

```bash
sudo adduser pslink --home-dir /opt/pslink
```

--------------------------------

### Create Pslink Data Directory

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Creates a new directory and navigates into it. This directory is intended for storing Pslink configuration and data files, especially when setting up for production use.

```bash
mkdir ~/pslink-data
cd ~/pslink-data
```

--------------------------------

### Create and Set Permissions for Pslink Directory

Source: https://github.com/enaut/pslink/blob/main/README.md

Creates the primary directory for Pslink at '/opt/pslink', changes its ownership to the 'pslink' user and group, and sets restrictive permissions (700) for security.

```bash
sudo mkdir -p /opt/pslink
sudo chown pslink:pslink /opt/pslink
sudo chmod 700 /opt/pslink
```

--------------------------------

### Manage Pslink Container Lifecycle

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Essential commands for managing the Pslink container's lifecycle. These commands allow you to view logs for debugging, stop a running container, and completely remove a container instance.

```bash
# View logs
podman logs pslink_container

# Stop the container
podman stop pslink_container

# Remove the container
podman rm pslink_container
```

--------------------------------

### Run Pslink Container with Persistent Data

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Launches the Pslink server in a detached container with persistent database and environment files. This requires pre-existing `links.db` and `.env` files. Adjust paths and consider omitting the `:Z` option if SELinux is not in use.

```bash
podman run -d --name pslink_container \
  -v ./links.db:/app/links.db:Z \
  -v ./.env:/app/.env:Z \
  -p 8080:8080 \
  ghcr.io/enaut/pslink:latest
```

--------------------------------

### Migrate Pslink SQLite Database

Source: https://github.com/enaut/pslink/blob/main/README.md

This command initializes or updates the SQLite database used by Pslink. The database file location is specified in the `.env` configuration. This step is crucial for setting up the application's data storage.

```bash
pslink migrate-database
```

--------------------------------

### Create Initial Pslink Admin User

Source: https://github.com/enaut/pslink/blob/main/README.md

This interactive command creates the first administrator account for Pslink. Since the application lacks a public registration function, an admin user is necessary to manage the system. The command will prompt for a username and password.

```bash
pslink create-admin
```

--------------------------------

### Restart Pslink Container

Source: https://github.com/enaut/pslink/blob/main/doc/BuildContainer.md

Restarts the Pslink container to apply any recent configuration changes, such as disabling demo mode. This ensures the server is running with the updated settings and environment variables.

```bash
podman restart pslink_container
```

--------------------------------

### View Pslink Service Logs

Source: https://github.com/enaut/pslink/blob/main/README.md

Retrieves and displays the journal logs specifically for the Pslink systemd service, which is useful for debugging and monitoring its operation.

```bash
sudo journalctl -u pslink
```

--------------------------------

### Check Pslink Service Status

Source: https://github.com/enaut/pslink/blob/main/README.md

Displays the current status of the Pslink systemd service, including whether it's active, running, and any recent log entries.

```bash
sudo systemctl status pslink
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.