### Install Docker on Ubuntu/Debian

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Installs Docker.io on Ubuntu or Debian-based systems using apt.

```bash
apt install docker.io
```

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

### Install Docker on Other Linux Distributions

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Installs Docker using a script from get.docker.com. Ensure you have curl installed.

```bash
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
```

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

### Install Docker Compose on Ubuntu/Debian

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Installs docker-compose on Ubuntu or Debian-based systems using apt.

```bash
apt install docker-compose
```

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

### Start NamelessMC Website

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Starts the NamelessMC website in detached mode using docker-compose.

```bash
docker-compose up -d
```

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

### Nginx Configuration for Arch Linux

Source: https://github.com/namelessmc/nameless/wiki/Using-NamelessMC-on-Arch-Linux-with-nginx

This is a sample Nginx configuration file. It includes basic settings for worker processes, event handling, HTTP configurations, and a server block with PHP processing. Modify the 'root' directive and socket path as per your server setup.

```nginx
worker_processes            auto;

events {
    worker_connections      1024;
}

http {
    include                 mime.types;
    default_type            application/octet-stream;

    log_format              main  '$remote_addr - $remote_user [$time_local] "$request" '
                                  '$status $body_bytes_sent "$http_referer" '
                                  '"$http_user_agent" "$http_x_forwarded_for"';

    sendfile                on;
    tcp_nopush              on;
    keepalive_timeout       65;
    gzip                    on;
    charset                 utf-8;

    server {
        listen              80;
        listen              [::]:80;
        index               index.html index.htm index.php;
        root                /srv/http/public;

        location / {
	ttry_files $uri $uri/ /index.php?$args;
#            try_files       $uri $uri/ =404;
        }

        location ~ \.php$ {
            fastcgi_pass    unix:/run/php-fpm/php-fpm.sock;
            fastcgi_index   index.php;
            include         fastcgi.conf;
        }
	error_page 404 /404.php;
    }
}

```

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

### Add Automated Sync Cron Job

Source: https://github.com/namelessmc/nameless/wiki/Setting-up-a-Cronjob-for-Donation-Page

Add this line to your crontab to schedule the store synchronization. Replace the example URL with your actual sync URL. This job will run every 5 minutes and suppress output.

```bash
*/5 * * * * wget -O - http://example.com/addons/donate/sync.php?key=blahblahblahblahcoffeeblahblah >/dev/null 2>&1
```

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

### POST /api/v1/{API_KEY}/getNotifications

Source: https://github.com/namelessmc/nameless/wiki/Using-the-Nameless-API

Gets unread notifications for a user.

```APIDOC
## POST /api/v1/{API_KEY}/getNotifications

### Description
Returns the number of unread private messages and alerts a user has.

### Method
POST

### Endpoint
/api/v1/{API_KEY}/getNotifications

### Parameters
#### Request Body
- **uuid** (string) - Required - Minecraft UUID or username of the user
```

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

### Download NamelessMC Docker Compose File

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Creates a directory for NamelessMC and downloads the docker-compose.yaml file.

```bash
mkdir -p /opt/nameless && cd /opt/nameless
wget https://raw.githubusercontent.com/NamelessMC/Nameless-Docker/master/docker-compose.yaml
```

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

### POST /api/v1/{API_KEY}/register

Source: https://github.com/namelessmc/nameless/wiki/Using-the-Nameless-API

Registers a new user on the website.

```APIDOC
## POST /api/v1/{API_KEY}/register

### Description
Registers a specified user. An email is sent to the user to complete registration.

### Method
POST

### Endpoint
/api/v1/{API_KEY}/register

### Parameters
#### Request Body
- **username** (string) - Required - The Minecraft username of the user
- **uuid** (string) - Required - The Minecraft UUID of the user
- **email** (string) - Required - The email address of the user
```

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

### Add phpMyAdmin Configuration to docker-compose.yaml

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Adds the phpMyAdmin service configuration to your existing docker-compose.yaml file. Ensure the ports are not exposed to the internet.

```yaml
phpmyadmin:
    image: phpmyadmin/phpmyadmin
    ports: ['127.0.0.1:8080:80']
    depends_on: [db]
    environment:
        PMA_HOST: db
        PMA_ABSOLUTE_URI: http://localhost:8080
        PMA_USER: nameless # Only specify if you want phpmyadmin to auto login
        PMA_PASSWORD: namelesss # Only specify if you want phpmyadmin to auto login
```

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

### Navigate to Cron Directory

Source: https://github.com/namelessmc/nameless/wiki/Setting-up-a-Cronjob-for-Donation-Page

Use this command to change the current directory to the cron job configuration directory. You may need to use `sudo su` to gain root privileges if you encounter permission errors.

```bash
cd /var/spool/cron/crontabs
```

```bash
sudo su
```

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

### POST /api/v1/{API_KEY}/createReport

Source: https://github.com/namelessmc/nameless/wiki/Using-the-Nameless-API

Creates a report about a user.

```APIDOC
## POST /api/v1/{API_KEY}/createReport

### Description
Creates a report about a given player.

### Method
POST

### Endpoint
/api/v1/{API_KEY}/createReport

### Parameters
#### Request Body
- **reporter_uuid** (string) - Required - UUID of the user creating the report
- **reported_uuid** (string) - Required - UUID of the user being reported
- **reported_username** (string) - Required - Username of the user being reported
- **content** (string) - Required - Reason for the report
```

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

### Edit Root Cron Tab

Source: https://github.com/namelessmc/nameless/wiki/Setting-up-a-Cronjob-for-Donation-Page

Open the root user's crontab file using the nano text editor. This is where you will add the new cron job entry.

```bash
nano root
```

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

### POST /api/v1/{API_KEY}/get

Source: https://github.com/namelessmc/nameless/wiki/Using-the-Nameless-API

Retrieves information about a specific user.

```APIDOC
## POST /api/v1/{API_KEY}/get

### Description
Retrieves information about a specified user using either their username or UUID.

### Method
POST

### Endpoint
/api/v1/{API_KEY}/get

### Parameters
#### Request Body
- **username** (string) - Optional - The Minecraft username of the user
- **uuid** (string) - Optional - The Minecraft UUID of the user

### Response
#### Success Response (200)
- **username** (string) - Minecraft username
- **displayname** (string) - Custom display name
- **uuid** (string) - Minecraft UUID
- **group_id** (integer) - Numeric group ID
- **registered** (integer) - UNIX timestamp of registration
- **banned** (integer) - Banned status (1 or 0)
- **validated** (integer) - Validated status (1 or 0)
- **reputation** (integer) - Site reputation
```

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

### Access phpMyAdmin via SSH Port Forwarding

Source: https://github.com/namelessmc/nameless/wiki/Install-Nameless-FAST

Forwards the local port 8080 to the server's port 8080 to securely access phpMyAdmin. This is recommended over exposing the port directly.

```bash
ssh -f root@yourserver -L 8080:localhost:8080 -N
```

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

### POST /api/v1/{API_KEY}/updateUsername

Source: https://github.com/namelessmc/nameless/wiki/Using-the-Nameless-API

Updates a user's Minecraft username.

```APIDOC
## POST /api/v1/{API_KEY}/updateUsername

### Description
Updates a user's Minecraft username on the website.

### Method
POST

### Endpoint
/api/v1/{API_KEY}/updateUsername

### Parameters
#### Request Body
- **id** (string) - Required - Minecraft UUID or current website username
- **new_username** (string) - Required - New username for the website user
```

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

### POST /api/v1/{API_KEY}/setGroup

Source: https://github.com/namelessmc/nameless/wiki/Using-the-Nameless-API

Updates a user's group on the website.

```APIDOC
## POST /api/v1/{API_KEY}/setGroup

### Description
Sets a specified user's group on the website.

### Method
POST

### Endpoint
/api/v1/{API_KEY}/setGroup

### Parameters
#### Request Body
- **username** (string) - Optional - The Minecraft username of the user
- **uuid** (string) - Optional - The Minecraft UUID of the user
- **group_id** (integer) - Required - The website group ID
```

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