https://github.com/ornicar/zulip-lichess

Multi-purpose Zulip bot for the Lichess workspace
https://github.com/ornicar/zulip-lichess

lichess zulip zulip-bot

Last synced: 15 days ago
JSON representation

Multi-purpose Zulip bot for the Lichess workspace

• Host: GitHub
• URL: https://github.com/ornicar/zulip-lichess
• Owner: ornicar
• License: mit
• Created: 2021-06-25T15:15:04.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-08-30T09:11:41.000Z (over 2 years ago)
• Last Synced: 2024-12-16T00:34:53.703Z (15 days ago)
• Topics: lichess, zulip, zulip-bot
• Language: TypeScript
• Homepage:
• Size: 42 KB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zulip Lichess bot

Multi-purpose Zulip bot for the Lichess workspace.

## Usage

## Setup

In Zulip, go to Settings -> Your bots, and add a new bot.

You may name it `zuli` as I did, or anything else you like.

After it's created, download its `zuliprc` file and put it at the root of this project.

```

yarn install

yarn dev

```

And you're set, try using it from your Zulip instance.

## Redis configuration

To set a redis port, password, or database, use these environment variables:

```

REDIS_PORT

REDIS_PASSWORD

REDIS_DB

```

Example:

```

REDIS_PORT=9379 REDIS_DB=5 yarn dev

```

## Production

Build a prod release:

```

yarn build

```

Deploy it to a server:

```

rsync -av zuliprc dist node_modules user@server:/home/zulip-lichess/

```

Start it on the server:

```

node dist/index.js

```

### Systemd service definition

```

[Unit]

Description=Zulip Lichess bot

After=network.target

[Service]

User=root

Group=root

WorkingDirectory=/home/zulip-lichess

Environment="REDIS_PASSWORD="

Environment="REDIS_PORT=6379"

ExecStart=/usr/bin/node dist/index.js

Restart=always

[Install]

WantedBy=multi-user.target

```