Skip to content

Latest commit

 

History

History
93 lines (74 loc) · 3.58 KB

README.md

File metadata and controls

93 lines (74 loc) · 3.58 KB
Raw

Nimble

Source Language

Last Commit

Licence Liberapay patrons

What

Automatically invite peers to scheduled Zoom Meetings.

Why

No need for manual invitations.

How

First, check out how to get access to Zoom's API.

Second, prepare system for Redis.

option="vm.overcommit_memory=1"
sudo sysctl -w "{option}"
sudo echo "{option}" >> /etc/sysctl.conf

Thirdly, run the docker-compose.yml, after adjusting its values & setting up your personalised Zoom Meetings configuration. Make sure to set the user directive according to your needs. For example, if your OS user is of the name zoominvitr & is of the UID 1001, then adjust this in the docker-compose.yml file.

Now, create the storage tree.

id zoominvitr # uid=1001(zoominvitr) gid=1001(zoominvitr) groups=1001(zoominvitr)
su - zoominvitr
mkdir -p ./zoominvitr/database
mkdir -p ./zoominvitr/app
mkdir -p ./zoominvitr/logs

Where

Linux via Docker

Goals

  • Reliability

Project Status

Production

TODO

  • Support E-Mail
  • Add good enough keyword filter via configuration
  • Quit early on invalid configuration
  • Error out on duplicate patternKeywords across Contexts
  • Allow usage of multiple Zoom accounts for single Context
  • Add Documentation on how to setup Zoom API Access
  • Add Documentation on how to retrieve User ID
  • Change Licence to AGPL
  • Open Source
  • Verify automatic Docker Hub Deployment
  • Make SSL/TLS work on Alpine inside Docker
  • Optimise Docker Compose YAML files
  • Improve Error Handling on Database Connection Defect
  • Cache Zoom responses for 1, 12 or 24 hours
  • Minimise Zoom API call amount
  • Save Contexts in Database
  • Make Meta Options configurable via Configuration File
  • Fix ambiguous Identifier
  • Fix API Response Caching
  • Implement appVersion
  • Publish via Nimble
  • Do not force both patternKeywordsNo or patternKeywordsYes to exist; either is enough
  • Allow either a patternKeywordsNo or a patternKeywordsYes to be duplicated across contexts
  • Do not push for 3 days schedule if 7 days notification was already pushed within 3 days
  • Allow non-English characters in patternKeywordsNo and patternKeywordsYes
  • Publish Configuration File Documentation

License

Copyright © 2023 Akito [email protected]

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.