Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ornicar/zulip-remind
Zulip bot that posts messages in a stream at a fixed date.
https://github.com/ornicar/zulip-remind
zulip zulip-api zulip-bot
Last synced: about 2 months ago
JSON representation
Zulip bot that posts messages in a stream at a fixed date.
- Host: GitHub
- URL: https://github.com/ornicar/zulip-remind
- Owner: ornicar
- License: mit
- Created: 2021-06-24T09:12:30.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T10:56:21.000Z (about 2 years ago)
- Last Synced: 2023-03-10T21:18:29.145Z (almost 2 years ago)
- Topics: zulip, zulip-api, zulip-bot
- Language: TypeScript
- Homepage:
- Size: 80.1 KB
- Stars: 15
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zulip Remind
Zulip bot that posts messages in a stream at a fixed date.
Also see: https://github.com/apkallum/zulip-reminder-bot.
I wanted a single service using redis, with support for fixed dates and public stream posting.
## Usage
Use `@remind` to set a reminder for yourself, or for a stream.
Some examples include:
- `@remind me on June 1st to wish Linda happy birthday`
- `@remind me to stop procrastinating tomorrow`
- `@remind here in 3 hours to update the project status`
- `@remind stream to party hard on 2021-09-27 at 10pm`
Use `@remind list` to see the list of all your reminders.
Use `@remind delete` id to delete a reminder by its ID
## Setup
### Manual
In Zulip, go to Settings -> Your bots, and add a new bot.
You may name it `remind` 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.
### Docker
You can easily start the docker container with:
```
docker-compose up -d
```
Then a Redis database will start and the reminder automatically connects to it.
Please provide the `zuliprc` file and put it at the root of this project.
As host you need to provide the IP address of the computer the docker-compose is running on as REDIS_HOST.
You also need to set the REDIS_PASSWORD for the container to work.
The port is optional, if not set the standard port 6379 will be taken.
To set these variables mentioned above please copy the .env.example file and paste it as .env file and populate its fields.
## Redis configuration
To set a redis port, password, or database, use these environment variables:
```
REDIS_PORT
REDIS_PASSWORD
REDIS_DB
REDIS_HOST
```
Example:
```
REDIS_PORT=9379 REDIS_DB=5 REDIS_HOST=127.0.0.1 yarn dev
```
## Production
Build a prod release:
```
yarn build
```
Deploy it to a server:
```
rsync -av zuliprc dist node_modules user@server:/home/zulip-remind/
```
Start it on the server:
```
node dist/index.js
```
### Systemd service definition
```
[Unit]
Description=Zulip remind bot
After=network.target
[Service]
User=root
Group=root
WorkingDirectory=/home/zulip-remind
Environment="REDIS_PASSWORD="
Environment="REDIS_PORT=6379"
ExecStart=/usr/bin/node dist/index.js
Restart=always
[Install]
WantedBy=multi-user.target
```