LIVCK

https://help.livck.com
Admin
LIVCK is a self-hosted status page platform that monitors uptime, sends notifications across...
Tokens:39,872
Snippets:550
Trust Score:6
Update:7 months ago
Show doc for...
Tokens:
Raw
### Install Essential Dependencies (Bash)

Source: https://help.livck.com/installation

Installs necessary command-line utilities like unzip, wget, and curl, and then proceeds to install Docker by downloading and executing the official installation script. These tools are crucial for downloading files and managing containers.

```bash
apt -y install unzip wget curl

```

```bash
curl https://get.docker.com | sh

```

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

### Prepare and Run LIVCK Installation Script (Bash)

Source: https://help.livck.com/installation

Navigates to the LIVCK application directory, makes the installation script executable, and then runs it. The script will prompt for necessary configuration details to set up the application, including database, mail, and SSL settings.

```bash
cd livck

```

```bash
chmod +x install.sh

```

```bash
./install.sh

```

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

### Start the LIVCK Discord Bot Server

Source: https://help.livck.com/discord-bot

This command starts the main server process for the LIVCK Discord bot. Ensure all dependencies are installed and environment variables are configured.

```bash
node server.js
```

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

### Download LIVCK Application Files (Bash)

Source: https://help.livck.com/installation

Downloads the LIVCK self-hosted application zip file from the official source. Before running this command, ensure your license key is obtained from the LIVCK Dashboard and your server's IP is added to the allowlist. Replace 'PLACEHOLDER-LICENSE' with your actual license key.

```bash
cd /opt && wget -4 https://livck.com/dl/self-hosted/PLACEHOLDER-LICENSE -O livck.zip

```

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

### Install Node.js Dependencies for LIVCK Bot

Source: https://help.livck.com/discord-bot

After cloning the repository, this command installs all necessary Node.js dependencies for the LIVCK Discord bot. Ensure you have Node.js and npm installed.

```bash
npm install
```

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

### Update Package Lists and Packages (Bash)

Source: https://help.livck.com/installation

Updates the local package index and upgrades installed packages to their latest versions on an Ubuntu system. This is a standard first step before installing new software to ensure all components are up-to-date.

```bash
apt update

```

```bash
apt upgrade

```

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

### Extract and Organize LIVCK Files (Bash)

Source: https://help.livck.com/installation

Extracts the downloaded LIVCK zip archive, moves the application files to the correct directory, and then removes the temporary zip file and extracted directories. This prepares the application for configuration.

```bash
unzip livck.zip

```

```bash
mkdir livck && mv LIVCK-self-hosted-*/* /opt/livck

```

```bash
rm LIVCK-self-hosted-* -R && rm livck.zip

```

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

### Automated Installation

Source: https://help.livck.com/check-types

Recommended method for installing the heartbeat monitor using a generated script.

```APIDOC
## Automated Installation (Recommended)

### Description
This method involves running a curl command that downloads and executes an installation script. The script automates the setup of the heartbeat as a cron job, configures the interval, and sets necessary permissions.

### Method
Shell (curl)

### Endpoint
`https://status.example.com/heartbeat-install/{unique_token}`

### Parameters
#### Path Parameters
- **unique_token** (string) - Required - A unique token specific to each Heartbeat monitor.

### Request Example
```bash
curl https://status.example.com/heartbeat-install/X3jqostsxwJj6arG | bash
```

### Response
This method does not return a direct API response but rather executes a script on the server.
```

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

### Custom PHP.ini Configuration Example

Source: https://help.livck.com/changelog

This example illustrates how to configure custom PHP settings, specifically increasing the memory limit. This is often done to accommodate larger data processing or complex operations.

```ini
; Custom PHP.ini configuration
memory_limit = 512MB
```

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

### Configure LIVCK Bot Environment Variables

Source: https://help.livck.com/discord-bot

This command copies the example environment file to a new file named `.env`. You should then edit this `.env` file with your specific credentials and configuration settings.

```bash
cp .env.example .env
# Edit .env with your credentials
```

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

### Navigate to LIVCK Directory

Source: https://help.livck.com/upgrade

Changes the current directory to the LIVCK installation path. This is the first step before performing any upgrade operations.

```bash
cd /opt/livck

```

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

### Automated LIVCK Heartbeat Installation Script

Source: https://help.livck.com/check-types

This script automates the installation of the LIVCK heartbeat as a cron job, configuring the interval and permissions. It requires server access to run the curl command.

```bash
curl https://status.example.com/heartbeat-install/X3jqostsxwJj6arG | bash

```

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

### Update Install Script with Docker Compose

Source: https://help.livck.com/changelog

This snippet shows how to update the install script to use 'docker compose' instead of the deprecated 'docker-compose'. This is a common change for projects migrating to newer Docker versions.

```bash
# Example of updating install script
# Original command (deprecated):
docker-compose up -d

# Updated command:
docker compose up -d
```

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

### Heartbeat Check Example URL

Source: https://help.livck.com/check-types

This is an example URL endpoint generated by LIVCK for a Heartbeat monitor. Your service must call this URL periodically to signal that it is active.

```text
https://status.example.com/api/v3/health-check/X3jqostsxwJj6arG
```

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

### Install Script Improvements (Bash)

Source: https://help.livck.com/changelog

The install.sh script has undergone several improvements, including port checks (80 & 443), whitelist checks, colored error messages, and checks for the compose stack's running state with timeouts. It also includes credentials, login links, and container state checks for smoother deployment.

```bash
# Example snippet demonstrating install script improvements (conceptual)
# This is a placeholder as the actual install.sh content is not provided.
# The description covers functionalities like port checks, whitelist checks, etc.
echo "Starting Livck installation..."
# ... (port checks, whitelist checks, compose stack checks would be here) ...
echo "Installation complete."
```

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

### Manual LIVCK Heartbeat Cron Job Setup

Source: https://help.livck.com/check-types

Manually add a cron entry to call the LIVCK heartbeat URL at a specified interval. This method ensures the heartbeat is checked regularly without automated setup.

```cron
# Call heartbeat every minute
* * * * * curl -s https://status.example.com/api/v3/health-check/X3jqostsxwJj6arG > /dev/null 2>&1

```

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

### Run LIVCK Update Command

Source: https://help.livck.com/upgrade

Executes the LIVCK update command within the running application container. The --force flag ensures the update process completes even if there are minor conflicts.

```bash
docker compose exec app php artisan update --force

```

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

### From Application Code

Source: https://help.livck.com/check-types

Examples of how to integrate heartbeat checks directly into your application code using various programming languages.

```APIDOC
## From Application Code

### Description
Integrate heartbeat checks directly into your application code to ensure LIVCK is notified of your service's health. Examples are provided for PHP (Laravel), Python, Node.js, and Shell Script.

### Method
HTTP GET Request

### Endpoint
`https://status.example.com/api/v3/health-check/{unique_token}`

### Parameters
#### Path Parameters
- **unique_token** (string) - Required - A unique token specific to each Heartbeat monitor.

### Request Examples
#### PHP (Laravel)
```php
use Illuminate\Support\Facades\Http;

Http::get('https://status.example.com/api/v3/health-check/X3jqostsxwJj6arG');
```

#### Python
```python
import requests
requests.get('https://status.example.com/api/v3/health-check/X3jqostsxwJj6arG')
```

#### Node.js
```javascript
const axios = require('axios');
axios.get('https://status.example.com/api/v3/health-check/X3jqostsxwJj6arG');
```

#### Shell Script
```bash
#!/bin/bash
curl -s https://status.example.com/api/v3/health-check/X3jqostsxwJj6arG
```

### Response
These code examples initiate an HTTP GET request. The success or failure of the request depends on network connectivity and the LIVCK service status. No specific JSON response body is detailed for these direct calls, as the primary purpose is to signal health to LIVCK.
```

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

### Clone LIVCK Discord Bot Repository

Source: https://help.livck.com/discord-bot

This command clones the LIVCK Discord bot repository from GitHub to your local machine. Ensure you have Git installed.

```bash
git clone https://github.com/LIVCK/livck-discord-bot.git
cd livck-discord-bot
```

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

### Pull Latest Docker Image for LIVCK

Source: https://help.livck.com/upgrade

Pulls the latest Docker image for the LIVCK application from the registry. This ensures that the application will be updated to the newest version.

```bash
docker compose pull app

```

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

### Send Test Notification to Slack

Source: https://help.livck.com/slack-notifications

This command-line snippet demonstrates how to test a Slack incoming webhook by sending a simple JSON payload. It requires `curl` to be installed and the correct webhook URL.

```shell
curl -X POST -H 'Content-type: application/json' \
--data '{"text":"Test from LIVCK"}' \
YOUR_WEBHOOK_URL
```

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

### View Nginx Logs using Docker Compose

Source: https://help.livck.com/advanced-configuration

This command displays the logs from the Nginx container within the Docker Compose setup. Examining these logs is crucial for diagnosing issues related to Nginx configuration, request handling, and potential errors.

```bash
docker compose logs app
```

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

### Restart Docker Stack with New LIVCK Image

Source: https://help.livck.com/upgrade

Restarts the Docker containers for the LIVCK application to utilize the newly pulled Docker image. This command ensures the application runs with the updated code.

```bash
docker compose up -d

```

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

### Run Database Migrations for LIVCK Bot

Source: https://help.livck.com/discord-bot

This command executes the database migration scripts to set up or update your database schema for the LIVCK Discord bot. Ensure your database is configured in the `.env` file.

```bash
node migrate.js
```

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

### Correct File Permissions for LIVCK

Source: https://help.livck.com/upgrade

Corrects file permissions for the storage and bootstrap/cache directories within the LIVCK installation. This is crucial for the application to write necessary files and cache data.

```bash
chmod -R gu+w storage/ && chmod -R guo+w storage/ && chmod -R gu+w bootstrap/cache/ && chmod -R guo+w bootstrap/cache/

```

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

### Test Certbot with Staging Environment using Docker Compose

Source: https://help.livck.com/advanced-configuration

This command tests the Certbot process for obtaining an SSL certificate using Let's Encrypt's staging environment. This is useful for troubleshooting Certbot issues without hitting production rate limits. It requires the domain, email, and the `--staging` flag.

```bash
docker compose exec app certbot --nginx -d your-domain.com --email your-email@example.com --agree-tos --staging --non-interactive
```

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

### View Application Logs with Docker Compose

Source: https://help.livck.com/advanced-configuration

Displays the application logs for the 'app' service. This is essential for debugging errors and monitoring application behavior. The '-f' flag allows for real-time log streaming.

```bash
docker compose logs app
```

```bash
docker compose logs -f app
```

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

### Configure SMS Notifications with ClickSend API

Source: https://help.livck.com/changelog

This code snippet demonstrates the configuration steps for setting up SMS notifications using the ClickSend service. It requires a ClickSend account, API key, and specific environment variables.

```bash
# .env file configuration for ClickSend
CLICKSEND_USERNAME="your_clicksend_username"
CLICKSEND_API_KEY="your_clicksend_api_key"
```

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

### Check LIVCK Application Logs for Pushover Errors

Source: https://help.livck.com/pushover-notifications

This command helps diagnose Pushover notification issues by filtering application logs for relevant messages. It requires access to your LIVCK application's logs via Docker.

```shell
docker compose logs app | grep -i pushover
```

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

### Clear LIVCK Cache

Source: https://help.livck.com/upgrade

Clears the application cache for LIVCK. This command ensures that any old cached data is removed, allowing the application to use fresh data after the upgrade.

```bash
docker compose exec app php artisan cache:clear

```

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

### Check Telegram Notification Logs

Source: https://help.livck.com/telegram-notifications

This command helps diagnose issues with Telegram notifications by filtering log output from the LIVCK application. It requires Docker to be installed and running.

```bash
docker compose logs app | grep -i telegram
```

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

### Add Domain with HTTP + SSL using Docker Compose

Source: https://help.livck.com/advanced-configuration

This command adds a new domain to the LIVCK status page configuration, sets up Nginx, and obtains an SSL certificate from Let's Encrypt. It requires root or sudo access and pre-configured DNS records. The command uses environment variables for the new domain and email address.

```bash
NEW_DOMAIN="status.example.com" && EMAIL="admin@example.com" && sed "s/INSTALLER-REPLACEMENT/$NEW_DOMAIN/g" /opt/livck/docker/web/sites/default.sample >> /opt/livck/docker/web/sites/default.conf && docker compose exec app nginx -t && docker compose exec app certbot --nginx -d $NEW_DOMAIN --email $EMAIL --agree-tos --non-interactive
```

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

### View Newsletter Logs with Docker Compose

Source: https://help.livck.com/newsletter

This command allows you to view logs related to the newsletter service within your Docker environment. It filters for messages containing 'newsletter' in a case-insensitive manner. Ensure you have Docker Compose installed and configured for your project.

```bash
docker compose logs app | grep -i newsletter
```

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

### Update Manual Check via LIVCK API v2

Source: https://help.livck.com/check-types

This example demonstrates how to update a Manual Check status programmatically using the LIVCK API v2. It requires an API token generated from the user profile.

```bash
# Example using curl (replace with your actual API endpoint and token)
curl -X POST https://livck.com/api/v2/monitors/{monitor_id}/status \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -d "status=OK"
```
Tokens:
Raw