Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.86 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.86 KB
Raw

gomeet

A meeting reminder and auto-joiner that simplifies meeting management by automatically storing, retrieving, and opening meeting links

GitHub go.mod Go version Go Report Card GitHub License GitHub Workflow Status Static Badge

Configuration

Before using gomeet, configure it with your details in a valid JSON format. You'll find an example configuration file config.json to get you started.

Important

The config.json file is placed in the configuration directory of your system:

  • Windows: it's %AppData%\gomeet\ (i.e. C:\Users\<user-name>\AppData\Roaming\gomeet\).
  • Darwin: it's $HOME/Library/Application Support/gomeet/.
  • Gnu/Linux: it's $XDG_CONFIG_HOME/gomeet/, if non-empty, else $HOME/.config/gomeet/.

Adding calendars

Local Calendar: Include your local calendar details in the "events" array within config.json.

Google Calendar:

Important

The URL of the event should be placed in Location (الموقع الجغرافي) field.

Build

Requirements: Go programming language (version go1.22.1 or later)

make build

Usage

Manual launch

Simply run the built binary to start the program as a background daemon.

./bin/gomeet.exe &

Startup as Service (Windows only)

  1. Open the registry editor (regedit).
  2. Navigate to HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Run.
  3. Create a new String Value named GoMeet.
  4. Set the GoMeet value to the full path of the gomeet executable (e.g., C:\bin\gomeet.exe).

For automatic startup on Unix-based systems, refer to your specific distribution's documentation on creating systemd or runit services.

Note

gomeet logs important events (errors, warnings) to a log file for troubleshooting.

  • Windows: %LocalAppData%\gomeet\logs\ or C:\Users\<user-name>\AppData\Local\gomeet\logs\.
  • Darwin: ~/Library/Logs/gomeet/.
  • Gnu/Linux: /var/log/gomeet/

License

Licensed under the GPL-v3 License.