Zeppelin

https://github.com/zeppelinbot/zeppelin
Admin
Zeppelin is a moderation bot for Discord, designed with large servers and reliability in mind.
Tokens:1,357
Snippets:22
Trust Score:6.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Development Environment with Docker Compose

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/DEVELOPMENT.md

This command initiates the development environment using Docker Compose. It requires a docker-compose.development.yml file and a populated .env file for configuration. Ensure Docker is installed and running before execution.

```bash
docker compose -f docker-compose.development.yml up
```

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

### Start Backend (Bot + API) with npm Watch

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/DEVELOPMENT.md

Starts the backend services (bot and API) in watch mode using npm. This command recompiles code automatically upon changes, facilitating rapid backend development. Navigate to the backend directory within the container before running.

```bash
cd ~/zeppelin/backend
npm run watch
```

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

### Install Project Dependencies with npm

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/DEVELOPMENT.md

Installs project dependencies using npm ci, which is optimized for continuous integration environments. It ensures that exact versions of dependencies are installed as specified in the package-lock.json file. This command should be run inside the development container.

```bash
npm ci
```

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

### Start Dashboard with npm Watch

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/DEVELOPMENT.md

Starts the dashboard in watch mode using npm. This enables automatic recompilation and hot-reloading for frontend changes, streamlining dashboard development. Ensure you are in the dashboard directory within the container.

```bash
cd ~/zeppelin/dashboard
npm run watch
```

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

### Run Zeppelin Lightweight with Docker Compose

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command initiates the Zeppelin bot in a lightweight production setup using Docker Compose. It assumes a configured docker-compose.lightweight.yml file and operates in detached mode.

```bash
docker compose -f docker-compose.lightweight.yml up -d
```

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

### Update Dashboard Watch Command

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/MIGRATE_DEV.md

This snippet shows the recommended command to watch for changes in the dashboard development environment. It replaces the older 'npm run watch-build' command.

```shell
npm run watch
```

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

### Run Zeppelin API Service Manually

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command starts the Zeppelin API service using a Docker container. It executes the 'npm run start-api' script inside the container.

```bash
docker run zeppelin npm run start-api
```

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

### Run Zeppelin Standalone with Docker Compose

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command starts the Zeppelin bot in a standalone production environment using Docker Compose. It requires a pre-configured docker-compose.standalone.yml file and runs the services in detached mode.

```bash
docker compose -f docker-compose.standalone.yml up -d
```

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

### View Zeppelin Lightweight Logs

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command displays the logs from the Zeppelin lightweight Docker containers with real-time updates. Timestamps are included with the -t flag, and -f keeps the output following new log entries.

```bash
docker compose -f docker-compose.lightweight.yml logs -t -f
```

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

### View Zeppelin Standalone Logs

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command streams the logs from the Zeppelin standalone Docker containers in real-time. The -t flag adds timestamps, and -f follows the log output.

```bash
docker compose -f docker-compose.standalone.yml logs -t -f
```

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

### Allow Server Invitation - Zeppelinbot

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/MANAGEMENT.md

Allows a server to invite the Zeppelinbot. Optionally grants 'Bot manager' access to a specified user.

```Shell
@Bot allow_server <serverId> [userId]
```

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

### Run Zeppelin with Environment Variables

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command demonstrates running a Zeppelin Docker container with specific environment variables set. It includes setting the NODE_ENV to 'production' and loading additional variables from a .env file.

```bash
docker run -e NODE_ENV=production --env-file .env zeppelin
```

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

### Run Zeppelin Bot Service Manually

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command runs the Zeppelin bot service from a pre-built Docker image. It executes the 'npm run start-bot' script within the container.

```bash
docker run zeppelin npm run start-bot
```

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

### Build Zeppelin Docker Image Manually

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command builds the Docker image for Zeppelin using its Dockerfile. The resulting image is tagged as 'zeppelin' and can be used for manual service deployments.

```bash
docker build --tag 'zeppelin' .
```

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

### Run Zeppelin Dashboard Service Manually

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command launches the Zeppelin dashboard service within a Docker container. It runs the 'npm run start-dashboard' script.

```bash
docker run zeppelin npm run start-dashboard
```

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

### Stop Zeppelin Lightweight with Docker Compose

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command halts and removes the Docker containers specified in the docker-compose.lightweight.yml file, effectively stopping the lightweight Zeppelin production environment.

```bash
docker compose -f docker-compose.lightweight.yml down
```

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

### Rebuild Zeppelin Lightweight Docker Image

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command rebuilds the Docker images defined in the docker-compose.lightweight.yml file. It's used after code updates to ensure the running services are using the latest code.

```bash
docker compose -f docker-compose.lightweight.yml build
```

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

### Stop Zeppelin Standalone with Docker Compose

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command stops and removes the containers defined in the docker-compose.standalone.yml file, effectively shutting down the standalone Zeppelin production environment.

```bash
docker compose -f docker-compose.standalone.yml down
```

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

### Grant Dashboard Access - Zeppelinbot

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/MANAGEMENT.md

Grants specified users access to a server's dashboard management.

```Shell
@Bot add_dashboard_user <serverId> <userId...>
```

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

### Rebuild Zeppelin Standalone Docker Image

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/PRODUCTION.md

This command rebuilds the Docker images defined in the docker-compose.standalone.yml file. This is typically done after updating the Zeppelin code base before restarting the services.

```bash
docker compose -f docker-compose.standalone.yml build
```

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

### Disallow Server - Zeppelinbot

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/MANAGEMENT.md

Removes a server's ability to have the Zeppelinbot invited or connected.

```Shell
@Bot disallow_server <serverId>
```

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

### Remove Dashboard Access - Zeppelinbot

Source: https://github.com/zeppelinbot/zeppelin/blob/master/docs/MANAGEMENT.md

Removes specified users from a server's dashboard management access.

```Shell
@Bot remove_dashboard_user <serverId> <userId...>
```
Tokens:
Raw