muety

Open Source

Anchr

Anchr Anchr is a small toolbox for common tasks on the internet, including bookmarks, link shortening and image uploads. 🚀 Features Link shortener Searchable bookmarks collections Encrypted images uploads, using CryptoJS Malicious link checking, using Safe Browsing API Self-hosted and open-source Hosted, GDPR-compliant service at Anchr.io Official Android app Chrome and Firefox browser extension Prometheus metrics Integration with ShareX OAuth 2 authentication (Google, Facebook, ...) Telegram Bot (@AnchrBot) If you like this project, please consider sponsoring it! 🗒 Description The idea arose when someday I considered it useful to have a collection of web links or bookmarks – like those you have in Chrome or Firefox – accessible from anywhere without needing to synchronize your browser profile. Just like if you’re somewhere on another PC, find a useful article on the internet and want to save it quickly for later at home. This is what Anchr’s collections feature does. It saves links – with an optional description for easier search and separated into categories / collections. The second feature is to upload images. You can easily upload one or more photos from your computer or mobile device and send them to friends or include them into forum posts or the like. Special with Anchr’s image hosting is that users are given the opportunity to client-sided encrypt images with a password. As a result no one without the password will ever see their photos’ content. The last feature are shortlinks – actually not any different from those you know from goo.gl or bit.ly. They’re useful if you have a very long web link including many query parameters, access tokens, session ids, special characters and the like and want to share them. Often special characters break the linking or your chat application has a maximum length for hyperlinks. Or you just want to keep clarity in your document or emails. In this case it can be very helpful to make the links as short as any possible. Additionally, shortlinks are checked against Google's Safe Browsing API to prevent your site to reference phishing sites or the like. Anchr’s focus is on ease and quickness of use – short loading times, flat menu hierarchies, etc. There's also a Chrome extension out there, which you can use to save or shorten links directly from the website. 📡 How to run? Prerequisites In order to host Anchr on your own, you need a few things. Node.js >= 21.x MongoDB >= 6.x Alternative 1: Mongo Atlas (hosted cloud MongoDB) Alternative 2: FerretDB (with Postgres or SQLite) Database Setup Configuration Copy to and edit the contents to set environment variables: : TCP port to start the server on (default: ) : IPv4 address to make the server listen on (default: ) : Public base URL of your hosted instance (no trailing slash) (default: ) : MongoDB user name (default: ) : MongoDB password (required) : MongoDB host name (default: ) : MongoDB port (default: ) : MongoDB database name (default: ) : Absolute path to a file system directory (must exist!) to persist uploaded images to (default: ) : A (preferably long), random character sequence to be used for the JSON Web Token (default: ) : Absolute file path for access logs (directory must exist!) (default: ) : Absolute file path for error logs (directory must exist!) (default: ) : Your API key for Google APIs (required for safe browse checking incoming shortlinks), which you get from the Developers Console (default: , leave blank to disable safe browse checking) and : OAuth credentials for Facebook Login (default: , leave blank to disable Facebook login) and : OAuth credentials for Google Login (default: , leave blank to disable Google login) : Whether to allow sign up of new users (default: ) : Whether require new users to activate their accounts with an e-mail link (requires mailing) (default: ) : Whether to check new shortlinks against various blocklists to filter malicious content (default: ) : Whether to allow authenticating using HTTP Basic Auth (default: ) : Whether to expose Prometheus metrics under the public endpoint (default: ) : Sender address in mails from Anchr.io (default: ) : SMTP server host for sending mails (leave empty to disable mailing) : SMTP server port (default: ) : Whether to establish a TLS connection with the SMTP server (not to be confused with STARTTLS) (default: ) : SMTP server login username : SMTP server login password : Public URL of your MailWhale instance when using it for mails instead of SMTP (default: ) : MailWhale client ID for authentication : MailWhale client secret for authentication : Telegram bot token (from @BotFather). Leave empty for disabling Telegram integration. : Secret to append to Telegram webhook path for security purposes. Can be any random string. ⚙️ Run Setup Option 1: Run Natively For development Run backend Run frontend Go to and enjoy live reload In production (to build frontend) Option 2: Run with Docker 🤖 Telegram Bot Setup Create a new bot with @BotFather Configure and variables Configure the webhook: 🧰 Tooling ShareX (Windows only) You can integrate Anchr with ShareX on Windows and make it be used as a custom target for image uploads and shortlinks. Generate an HTTP basic auth hash Base64 hash of Option 1 (Linux): Option 2: Use an online tool Insert your newly generated hash in and Import both files as custom uploaders in ShareX 🧩 Project History The project's origins lie in 2014, back when the MEAN stack was the sht. It was the author's first real web project and a great opportunity to learn. The project is maintained ever since, however, considered mostly feature-complete. Dependencies are updated occasionally. Because the project started quite a couple of years ago, some parts are still based on old-fashioned JavaScript ES5 syntax, alongside vintage tools like Grunt and Bower. Certainly, this is not state-of-the-art in web dev anymore. However, to keep consistency with existing code, the original code style should still be followed in new contributions. Update: Just recently, all backend-side code was refactored to modern JavaScript syntax to ease development. 🧑‍💻 Developer Notes API Tests Upgrade packges 📓 License GNU General Public License v3 (GPL-3) @ Ferdinand Mütsch

Productivity Link Shortening & Tracking Bookmarks & Link Saving

384 Github Stars

Wakapi

<img src="static/assets/images/logo-gh.svg" width="350"> <img src="https://img.shields.io/github/license/muety/wakapi"> <a href="https://liberapay.com/muety/"><img src="https://img.shields.io/liberapay/receives/muety.svg?logo=liberapay"></a> <img src="https://wakapi.dev/api/badge/n1try/interval:any/project:wakapi?label=wakapi"> <img src="https://img.shields.io/github/languages/code-size/muety/wakapi"> <a href="https://goreportcard.com/report/github.com/muety/wakapi"><img src="https://goreportcard.com/badge/github.com/muety/wakapi"></a> <a href="https://sonarcloud.io/dashboard?id=muety_wakapi"><img src="https://sonarcloud.io/api/project_badges/measure?project=muety_wakapi&metric=ncloc"></a> <h3 align="center">A minimalist, self-hosted WakaTime-compatible backend for coding statistics.</h3> <div align="center"> <h3> <a href="https://wakapi.dev">Website</a> | <a href="#-features">Features</a> | <a href="#%EF%B8%8F-how-to-use">How to use</a> | <a href="https://github.com/muety/wakapi/issues">Issues</a> | <a href="https://github.com/muety">Contact</a> </h3> </div> <img src="static/assets/images/screenshot.webp" width="500px"> > [!IMPORTANT] > Due to limited time available on the maintainers' part, we temporarily do not accept pull requests. Please refrain from submitting contributions for the time being. ## 🚀 Features * ✅ Free and open-source * ✅ Built by developers for developers * ✅ Statistics for projects, languages, editors, hosts and operating systems * ✅ Badges * ✅ Weekly E-Mail reports * ✅ REST API * ✅ Partially compatible with WakaTime * ✅ WakaTime integration * ✅ Support for Prometheus exports * ✅ Lightning fast * ✅ Self-hosted ## ⌨️ How to use? There are different options for how to use Wakapi, ranging from our hosted cloud service to self-hosting it. Regardless of which option choose, you will always have to do the [client setup](#-client-setup) in addition. ### ☁️ Option 1: Use [wakapi.dev](https://wakapi.dev) If you want to try out a free, hosted cloud service, all you need to do is create an account and then set up your client-side tooling (see below). ### 📦 Option 2: Quick-run a release ```bash $ curl -L https://wakapi.dev/get | bash ``` ### 🐳 Option 3: Use Docker ```bash # Create a persistent volume $ docker volume create wakapi-data $ SALT="$(cat /dev/urandom | LC_ALL=C tr -dc 'a-zA-Z0-9' | fold -w ${1:-32} | head -n 1)" # Run the container $ docker run -d \ --init \ -p 3000:3000 \ -e "WAKAPI_PASSWORD_SALT=$SALT" \ -v wakapi-data:/data \ --name wakapi \ --restart unless-stopped \ ghcr.io/muety/wakapi:latest ``` **Note:** By default, SQLite is used as a database. To run Wakapi in Docker with MySQL or Postgres, see [Dockerfile](https://github.com/muety/wakapi/blob/master/Dockerfile) and [config.default.yml](https://github.com/muety/wakapi/blob/master/config.default.yml) for further options. If you want to run Wakapi on **Kubernetes**, there is [wakapi-helm-chart](https://github.com/ricristian/wakapi-helm-chart) for quick and easy deployment. #### Docker Compose Alternatively, you can use Docker Compose for an even more straightforward deployment. See [compose.yml](https://github.com/muety/wakapi/blob/master/compose.yml) for configuration details. Wakapi supports [Docker Secrets](https://docs.docker.com/compose/how-tos/use-secrets/) for the following variables: `WAKAPI_PASSWORD_SALT`, `WAKAPI_DB_PASSWORD`, `WAKAPI_MAIL_SMTP_PASS`. You can set these either by having them mounted as a secret file, or directly pass them as environment variables. ##### Example ```bash export WAKAPI_PASSWORD_SALT=changeme export WAKAPI_DB_PASSWORD=changeme export WAKAPI_MAIL_SMTP_PASS=changeme docker compose up -d ``` If you prefer to persist data in a local directory while using SQLite as the database, make sure to set the correct `user` option in the Docker Compose configuration to avoid permission issues. ### 🧑‍💻 Option 4: Compile and run from source ```bash # Build and install # Alternatively: go build -o wakapi $ go install github.com/muety/wakapi@latest # Get default config and customize $ curl -o wakapi.yml https://raw.githubusercontent.com/muety/wakapi/master/config.default.yml $ vi wakapi.yml # Run it $ ./wakapi -config wakapi.yml ``` **Note:** Check the comments in `config.yml` for best practices regarding security configuration and more. 💡 When running Wakapi standalone (without Docker), it is recommended to run it as a [SystemD service](etc/wakapi.service). ### 💻 Client setup Wakapi relies on the open-source [WakaTime](https://github.com/wakatime/wakatime-cli) client tools. In order to collect statistics for Wakapi, you need to set them up. 1. **Set up WakaTime** for your specific IDE or editor. Please refer to the respective [plugin guide](https://wakatime.com/plugins) 2. **Edit your local `~/.wakatime.cfg`** file as follows. ```ini [settings] # Your Wakapi server URL or 'https://wakapi.dev/api' when using the cloud server api_url = http://localhost:3000/api # Your Wakapi API key (get it from the web interface after having created an account) api_key = 406fe41f-6d69-4183-a4cc-121e0c524c2b ``` Optionally, you can set up a [client-side proxy](https://github.com/muety/wakapi/wiki/Advanced-Setup:-Client-side-proxy) in addition. #### WakaTime integration You can use WakaTime and Wakapi in parallel, that is, have your coding activity tracked in both systems. This can be configured either on the **client-side (preferred)** on a system-wide- or per-project basis or using Wakapi's **relay** functionality (__Settings → Integrations__) to forward heartbeats to WakaTime. **Example:** ```ini [settings] api_key = defaults-to-this-api-key-when-not-defined-below [api_urls] .* = https://wakapi.dev/api|wakapi-api-key .* = https://api.wakatime.com/api/v1|waka-api-key ``` See [wakatime-cli usage](https://github.com/wakatime/wakatime-cli/blob/develop/USAGE.md#api-urls-section) for details. ## 🔧 Configuration options You can specify configuration options either via a config file (default: `config.yml`, customizable through the `-c` argument) or via environment variables. Here is an overview of all options. | YAML key / Env. variable | Default | Description | |---------------------------------------------------------------------------------------------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `env` / `ENVIRONMENT` | `dev` | Whether to use development- or production settings | | `app.leaderboard_enabled` / `WAKAPI_LEADERBOARD_ENABLED` | `true` | Whether to enable the public leaderboard | | `app.leaderboard_scope` / `WAKAPI_LEADERBOARD_SCOPE` | `7_days` | Aggregation interval for public leaderboard (see [here](https://github.com/muety/wakapi/blob/7d156cd3edeb93af2997bd95f12933b0aabef0c9/config/config.go#L71) for allowed values) | | `app.leaderboard_generation_time` / `WAKAPI_LEADERBOARD_GENERATION_TIME` | `0 0 6 * * *,0 0 18 * * *` | One or multiple times of day at which to re-calculate the leaderboard | | `app.leaderboard_require_auth` / `WAKAPI_LEADERBOARD_REQUIRE_AUTH` | `false` | Restrict leaderboard access to logged in users only | | `app.aggregation_time` / `WAKAPI_AGGREGATION_TIME` | `0 15 2 * * *` | Time of day at which to periodically run summary generation for all users | | `app.report_time_weekly` / `WAKAPI_REPORT_TIME_WEEKLY` | `0 0 18 * * 5` | Week day and time at which to send e-mail reports | | `app.data_cleanup_time` / `WAKAPI_DATA_CLEANUP_TIME` | `0 0 6 * * 0` | When to perform data cleanup operations (see `app.data_retention_months`) | | `app.optimize_database_time` / `WAKAPI_OPTIMIZE_DATABASE_TIME` | `0 0 8 1 * *` | When to perform database vacuuming (SQLite, Postgres) or table optimization (MySQL) | | `app.import_enabled` / `WAKAPI_IMPORT_ENABLED` | `true` | Whether data imports from WakaTime or other Wakapi instances are permitted | | `app.import_batch_size` / `WAKAPI_IMPORT_BATCH_SIZE` | `50` | Size of batches of heartbeats to insert to the database during importing from external services | | `app.import_backoff_min` / `WAKAPI_IMPORT_BACKOFF_MIN` | `5` | "Cooldown" period in minutes before user may attempt another data import | | `app.import_max_rate` / `WAKAPI_IMPORT_MAX_RATE` | `24` | Minimum number of hours to wait after a successful data import before user may attempt another one | | `app.import_hosts_whitelist` / `WAKAPI_IMPORT_HOSTS_WHITELIST` | - | List of whitelisted hostnames for data import (wildcards allowed, empty list means allow all) | | `app.inactive_days` / `WAKAPI_INACTIVE_DAYS` | `7` | Number of days after which to consider a user inactive (only for metrics) | | `app.heartbeat_max_age /` `WAKAPI_HEARTBEAT_MAX_AGE` | `4320h` | Maximum acceptable age of a heartbeat (see [`ParseDuration`](https://pkg.go.dev/time#ParseDuration)) | | `app.warm_caches /` `WAKAPI_WARM_CACHES` | `true` | Whether to perform some initial cache warming upon startup | | `app.custom_languages` | - | Map from file endings to language names | | `app.avatar_url_template` / `WAKAPI_AVATAR_URL_TEMPLATE` | (see [`config.default.yml`](config.default.yml)) | URL template for external user avatar images (e.g. from [Dicebear](https://dicebear.com) or [Gravatar](https://gravatar.com)) | | `app.date_format` / `WAKAPI_DATE_FORMAT` | `Mon, 02 Jan 2006` | Go time format strings to format human-readable date (see [`Time.Format`](https://pkg.go.dev/time#Time.Format)) | | `app.datetime_format` / `WAKAPI_DATETIME_FORMAT` | `Mon, 02 Jan 2006 15:04` | Go time format strings to format human-readable datetime (see [`Time.Format`](https://pkg.go.dev/time#Time.Format)) | | `app.support_contact` / `WAKAPI_SUPPORT_CONTACT` | `[email protected]` | E-Mail address to display as a support contact on the page | | `app.data_retention_months` / `WAKAPI_DATA_RETENTION_MONTHS` | `-1` | Maximum retention period in months for user data (heartbeats) (-1 for unlimited) | | `app.max_inactive_months` / `WAKAPI_MAX_INACTIVE_MONTHS` | `12` | Maximum number of inactive months after which to delete user accounts without data (-1 for unlimited) | | `server.port` / `WAKAPI_PORT` | `3000` | Port to listen on | | `server.listen_ipv4` / `WAKAPI_LISTEN_IPV4` | `127.0.0.1` | IPv4 network address to listen on (set to `'-'` to disable IPv4) | | `server.listen_ipv6` / `WAKAPI_LISTEN_IPV6` | `::1` | IPv6 network address to listen on (set to `'-'` to disable IPv6) | | `server.listen_socket` / `WAKAPI_LISTEN_SOCKET` | - | UNIX socket to listen on (set to `'-'` to disable UNIX socket) | | `server.listen_socket_mode` / `WAKAPI_LISTEN_SOCKET_MODE` | `0666` | Permission mode to create UNIX socket with | | `server.log_format` / `WAKAPI_LOG_FORMAT` | `text` | Format for structured logging (plain text or JSON) (options: `text`, `json`) | | `server.timeout_sec` / `WAKAPI_TIMEOUT_SEC` | `30` | Request timeout in seconds | | `server.tls_cert_path` / `WAKAPI_TLS_CERT_PATH` | - | Path of SSL server certificate (leave blank to not use HTTPS) | | `server.tls_key_path` / `WAKAPI_TLS_KEY_PATH` | - | Path of SSL server private key (leave blank to not use HTTPS) | | `server.base_path` / `WAKAPI_BASE_PATH` | `/` | Web base path (change when running behind a proxy under a sub-path) | | `server.public_url` / `WAKAPI_PUBLIC_URL` | `http://localhost:3000` | URL at which your Wakapi instance can be found publicly | | `security.disable_local_auth` / `WAKAPI_DISABLE_LOCAL_AUTH` | `false` | Disables login via local credentials (username and password) to enforce OIDC provider login | | `security.disable_webauthn` / `WAKAPI_DISABLE_WEBAUTHN` | `true` | Disables login via WebAuthn (security keys, biometrics, etc.) | | `security.password_salt` / `WAKAPI_PASSWORD_SALT` | - | Pepper to use for password hashing | | `security.insecure_cookies` / `WAKAPI_INSECURE_COOKIES` | `true` | Whether or not to allow cookies over HTTP. For production, it is **highly recommended** to serve Wakapi via HTTPS and set this to `false`. | | `security.cookie_max_age` / `WAKAPI_COOKIE_MAX_AGE` | `172800` | Lifetime of authentication cookies in seconds or `0` to use [Session](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#Define_the_lifetime_of_a_cookie) cookies | | `security.allow_signup` / `WAKAPI_ALLOW_SIGNUP` | `true` | Whether to enable local user registration | | `security.oidc_allow_signup` / `WAKAPI_OIDC_ALLOW_SIGNUP` | `true` | Whether to enable user registration via OIDC | | `security.oidc_insecure` / `WAKAPI_OIDC_INSECURE` | `false` | Skip TLS certificate validation for OIDC provider (only for debugging purposes!) | | `security.signup_captcha` / `WAKAPI_SIGNUP_CAPTCHA` | `false` | Whether the registration form requires solving a CAPTCHA | | `security.invite_codes` / `WAKAPI_INVITE_CODES` | `true` | Whether to enable registration by invite codes. Primarily useful if registration is disabled (invite-only server). | | `security.disable_frontpage` / `WAKAPI_DISABLE_FRONTPAGE` | `false` | Whether to disable landing page (useful for personal instances) | | `security.expose_metrics` / `WAKAPI_EXPOSE_METRICS` | `false` | Whether to expose Prometheus metrics under `/api/metrics` | | `security.trusted_header_auth` / `WAKAPI_TRUSTED_HEADER_AUTH` | `false` | Whether to enable trusted header authentication for reverse proxies (see [#534](https://github.com/muety/wakapi/issues/534)). **Use with caution!** | | `security.trusted_header_auth_key` / `WAKAPI_TRUSTED_HEADER_AUTH_KEY` | `Remote-User` | Header field for trusted header authentication. **Caution:** proxy must be configured to strip this header from client requests! | | `security.trusted_header_auth_allow_signup` / `WAKAPI_TRUSTED_HEADER_AUTH_ALLOW_SIGNUP` | `false` | Whether to allow creation of new users based on upstream trusted header authentication (see [#808](https://github.com/muety/wakapi/issues/808)) | | `security.trust_reverse_proxy_ips` / `WAKAPI_TRUST_REVERSE_PROXY_IPS` | - | Comma-separated list of IPv4 or IPv6 addresses or CIDRs of reverse proxies to trust to handle authentication (e.g. `172.17.0.1`, `192.168.0.0/24`, `[::1]`). | | `security.signup_max_rate` / `WAKAPI_SIGNUP_MAX_RATE` | `5/1h` | Rate limiting config for signup endpoint in format `<max_req>/<multiplier><unit>`, where `unit` is one of `s`, `m` or `h`. | | `security.login_max_rate` / `WAKAPI_LOGIN_MAX_RATE` | `10/1m` | Rate limiting config for login endpoint in format `<max_req>/<multiplier><unit>`, where `unit` is one of `s`, `m` or `h`. | | `security.password_reset_max_rate` / `WAKAPI_PASSWORD_RESET_MAX_RATE` | `5/1h` | Rate limiting config for password reset endpoint in format `<max_req>/<multiplier><unit>`, where `unit` is one of `s`, `m` or `h`. | | `security.oidc` | `[]` | List of OpenID Connect provider configurations (for details, see [wiki](https://github.com/muety/wakapi/wiki/OpenID-Connect-login-(SSO))) | | `security.oidc[0].name` / `WAKAPI_OIDC_PROVIDERS_0_NAME` | - | Name / identifier for the OpenID Connect provider (e.g. `gitlab`) | | `security.oidc[0].display_name` / `WAKAPI_OIDC_PROVIDERS_0_DISPLAY_NAME` | - | Optional "human-readable" display name for the provider presented to the user | | `security.oidc[0].client_id` / `WAKAPI_OIDC_PROVIDERS_0_CLIENT_ID` | - | OAuth client name with this provider | | `security.oidc[0].client_secret` / `WAKAPI_OIDC_PROVIDERS_0_CLIENT_SECRET` | - | OAuth client secret with this provider | | `security.oidc[0].endpoint` / `WAKAPI_OIDC_PROVIDERS_0_ENDPOINT` | - | OpenID Connect provider API entrypoint (for [discovery](https://openid.net/specs/openid-connect-discovery-1_0.html)) | | `security.oidc[0].username_claim` / `WAKAPI_OIDC_PROVIDERS_0_USERNAME_CLAIM` | - | Optionally spcified custom OIDC ID token claim to read username from (by `preferred_username`, `nickname` and `sub` are checked) | | `security.oidc[0].scopes` / `WAKAPI_OIDC_PROVIDERS_0_SCOPES` | - | Additional OAuth scopes to request beyond `openid`, `profile` and `email` (to be used in custom username claim) | | `db.host` / `WAKAPI_DB_HOST` | - | Database host | | `db.port` / `WAKAPI_DB_PORT` | - | Database port | | `db.socket` / `WAKAPI_DB_SOCKET` | - | Database UNIX socket (alternative to `host`) (for MySQL only) | | `db.user` / `WAKAPI_DB_USER` | - | Database user | | `db.password` / `WAKAPI_DB_PASSWORD` | - | Database password | | `db.name` / `WAKAPI_DB_NAME` | `wakapi_db.db` | Database name | | `db.dialect` / `WAKAPI_DB_TYPE` | `sqlite3` | Database type (one of `sqlite3`, `mysql`, `postgres`) | | `db.charset` / `WAKAPI_DB_CHARSET` | `utf8mb4` | Database connection charset (for MySQL only) | | `db.max_conn` / `WAKAPI_DB_MAX_CONNECTIONS` | `2` | Maximum number of database connections | | `db.ssl` / `WAKAPI_DB_SSL` | `false` | Whether to use TLS encryption for database connection (Postgres only) | | `db.compress` / `WAKAPI_DB_COMPRESS` | `false` | Whether to enable compression for database connection (MySQL only) | | `db.automgirate_fail_silently` / `WAKAPI_DB_AUTOMIGRATE_FAIL_SILENTLY` | `false` | Whether to ignore schema auto-migration failures when starting up | | `mail.enabled` / `WAKAPI_MAIL_ENABLED` | `false` | Whether to allow Wakapi to send e-mail (e.g. for password resets) | | `mail.sender` / `WAKAPI_MAIL_SENDER` | - | Default sender address for outgoing mails | | `mail.skip_verify_mx_record` / `WAKAPI_MAIL_SKIP_VERIFY_MX_RECORD` | `false` | Whether to skip validating MX DNS record for user email addresses | | `mail.provider` / `WAKAPI_MAIL_PROVIDER` | `smtp` | Implementation to use for sending mails (one of [`smtp`]) | | `mail.smtp.host` / `WAKAPI_MAIL_SMTP_HOST` | - | SMTP server address for sending mail (if using `smtp` mail provider) | | `mail.smtp.port` / `WAKAPI_MAIL_SMTP_PORT` | - | SMTP server port (usually 465) | | `mail.smtp.username` / `WAKAPI_MAIL_SMTP_USER` | - | SMTP server authentication username | | `mail.smtp.password` / `WAKAPI_MAIL_SMTP_PASS` | - | SMTP server authentication password | | `mail.smtp.tls` / `WAKAPI_MAIL_SMTP_TLS` | `false` | Whether the SMTP server requires TLS encryption (`false` for STARTTLS or no encryption) | | `mail.smtp.skip_verify` / `WAKAPI_MAIL_SMTP_SKIP_VERIFY` | `false` | Whether to allow invalid or self-signed certificates for TLS-encrypted SMTP | | `sentry.dsn` / `WAKAPI_SENTRY_DSN` | – | DSN for to integrate [Sentry](https://sentry.io) for error logging and tracing (leave empty to disable) | | `sentry.environment` / `WAKAPI_SENTRY_ENVIRONMENT` | (`env`) | Sentry [environment](https://docs.sentry.io/concepts/key-terms/environments/) tag (defaults to `env` / `ENV`) | | `sentry.enable_tracing` / `WAKAPI_SENTRY_TRACING` | `false` | Whether to enable Sentry request tracing | | `sentry.sample_rate` / `WAKAPI_SENTRY_SAMPLE_RATE` | `0.75` | Probability of tracing a request in Sentry | | `sentry.sample_rate_heartbeats` / `WAKAPI_SENTRY_SAMPLE_RATE_HEARTBEATS` | `0.1` | Probability of tracing a heartbeat request in Sentry | | `quick_start` / `WAKAPI_QUICK_START` | `false` | Whether to skip initial boot tasks. Use only for development purposes! | | `enable_pprof` / `WAKAPI_ENABLE_PPROF` | `false` | Whether to expose [pprof](https://pkg.go.dev/runtime/pprof) profiling data as an endpoint for debugging | ### Supported databases Wakapi uses [GORM](https://gorm.io) as an ORM. As a consequence, a set of different relational databases is supported. * [SQLite](https://sqlite.org/) (>= 3.31) (_default, easy setup_) * [MySQL](https://hub.docker.com/_/mysql) (_recommended, because most extensively tested_) * [MariaDB](https://hub.docker.com/_/mariadb) (_open-source MySQL alternative_) * [Postgres](https://hub.docker.com/_/postgres) (_open-source as well_) ## 🔐 Authentication Wakapi supports different types of user authentication. * **Cookie:** This method is used in the browser. Users authenticate by sending along an encrypted, secure, HTTP-only cookie (`wakapi_auth`) that was set in the server's response upon login. * **API key:** * **Via header:** This method is inspired by [WakaTime's auth. mechanism](https://wakatime.com/developers/#authentication) and is the common way to authenticate against API endpoints. Users set the `Authorization` header to `Basic <BASE64_TOKEN>`, where the latter part corresponds to your base64-hashed API key. * **Vis query param:** Alternatively, users can also pass their plain API key as a query parameter (e.g. `?api_key=86648d74-19c5-452b-ba01-fb3ec70d4c2f`) in the URL with every request. * **Trusted header:** This mechanism allows to delegate authentication to a **reverse proxy** (e.g. for SSO), that Wakapi will then trust blindly. See [#534](https://github.com/muety/wakapi/issues/534) for details. * Must be enabled via `trusted_header_auth` and configuring `trust_reverse_proxy_ip` in the config * Warning: This type of authentication is quite prone to misconfiguration. Make sure that your reverse proxy properly strips relevant headers from client requests. ### Single Sign-On / OpenID Connect Wakapi supports login via external identity providers via OpenID Connect. See [our wiki](https://github.com/muety/wakapi/wiki/OpenID-Connect-login-(SSO)) for details. You can also disable local authentication (username and password) entirely by setting `security.disable_local_auth` to `true`. This enforces login exclusively via your configured OIDC providers. ## 🔧 API endpoints See our [Swagger API Documentation](https://wakapi.dev/swagger-ui). ### Generating Swagger docs ```bash $ go install github.com/swaggo/swag/cmd/swag@latest $ swag init -o static/docs ``` ## 🤝 Integrations ### Prometheus export You can export your Wakapi statistics to Prometheus to view them in a Grafana dashboard or so. Here is how. ```bash # 1. Start Wakapi with the feature enabled $ export WAKAPI_EXPOSE_METRICS=true $ ./wakapi # 2. Get your API key and hash it $ echo "<YOUR_API_KEY>" | base64 # 3. Add a Prometheus scrape config to your prometheus.yml (see below) ``` #### Scrape config example ```yml # prometheus.yml # (assuming your Wakapi instance listens at localhost, port 3000) scrape_configs: - job_name: 'wakapi' scrape_interval: 1m metrics_path: '/api/metrics' bearer_token: '<YOUR_BASE64_HASHED_TOKEN>' static_configs: - targets: [ 'localhost:3000' ] ``` #### Grafana There is also a [nice Grafana dashboard](https://grafana.com/grafana/dashboards/12790), provided by the author of [wakatime_exporter](https://github.com/MacroPower/wakatime_exporter). ![](https://grafana.com/api/dashboards/12790/images/8741/image) ### WakaTime integration Wakapi plays well together with [WakaTime](https://wakatime.com). For one thing, you can **forward heartbeats** from Wakapi to WakaTime to effectively use both services simultaneously. In addition, there is the option to **import historic data** from WakaTime for consistency between both services. Both features can be enabled in the _Integrations_ section of your Wakapi instance's settings page. ### GitHub Readme Stats integrations Wakapi also integrates with [GitHub Readme Stats](https://github.com/anuraghazra/github-readme-stats#wakatime-week-stats) to generate fancy cards for you. Here is an example. To use this, don't forget to **enable public data** under [Settings -> Permissions](https://wakapi.dev/settings#permissions). <details> <summary>Click to view code</summary> ```markdown ![](https://github-readme-stats.vercel.app/api/wakatime?username={yourusername}&api_domain=wakapi.dev&bg_color=2D3748&title_color=2F855A&icon_color=2F855A&text_color=ffffff&custom_title=Wakapi%20Week%20Stats&layout=compact) ``` </details> ### GitHub Readme Metrics integration There is a [WakaTime plugin](https://github.com/lowlighter/metrics/tree/master/source/plugins/wakatime) for GitHub [Metrics](https://github.com/lowlighter/metrics/) that is also compatible with Wakapi. To use this, don't forget to **enable public data** under [Settings -> Permissions](https://wakapi.dev/settings#permissions). Preview: ![](https://raw.githubusercontent.com/lowlighter/metrics/examples/metrics.plugin.wakatime.svg) <details> <summary>Click to view code</summary> ```yml - uses: lowlighter/metrics@latest with: # ... other options plugin_wakatime: yes plugin_wakatime_token: ${{ secrets.WAKATIME_TOKEN }} # Required plugin_wakatime_days: 7 # Display last week stats plugin_wakatime_sections: time, projects, projects-graphs # Display time and projects sections, along with projects graphs plugin_wakatime_limit: 4 # Show 4 entries per graph plugin_wakatime_url: http://wakapi.dev # Wakatime url endpoint plugin_wakatime_user: .user.login # User ``` </details> ### Browser Plugin (Chrome & Firefox) The [browser-wakatime](https://github.com/wakatime/browser-wakatime) plugin enables you to track your web surfing in WakaTime (and Wakapi, of course). Visited websites will appear as "files" in the summary. Follow these instructions to get started: 1. Install the browser extension from the official store ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/wakatimes), [Chrome](https://chrome.google.com/webstore/detail/wakatime/jnbbnacmeggbgdjgaoojpmhdlkkpblgi?hl=de)) 2. Open the extension settings dialog 3. Configure it like so (see screenshot below): * API Key: Your personal API key (get it at [wakapi.dev](https://wakapi.dev)) * Logging Type: _Only the domain_ * API URL: `https://wakapi.dev/api/compat/wakatime/v1` (alternatively, replace _wakapi.dev_ with your self-hosted instance hostname) 4. Save 5. Start browsing! ![](.github/assets/screenshot_browser_plugin.png) Note: the plugin will only sync heartbeats once in a while, so it might take some time for them to appear on Wakapi. To "force" it to sync, simply bring up the plugin main dialog. ### Gnome Extension If you're using the GNOME desktop, there is a quick way to display your today's coding statistics in the status bar. ![](.github/assets/screenshot_gnome.png) Simply install the [Executor](https://extensions.gnome.org/extension/2932/executor/) extension and add the following command as a status bar indicator: ```bash ~/.wakatime/wakatime-cli-linux-amd64 --today ``` ## 📦 Data Export You can export your coding activity from Wakapi to CSV in the form of raw heartbeats. While there is no way to achieve this directly through the web UI, we provide an easy-to-use Python [script](scripts/download_heartbeats.py) instead. ```bash $ pip install requests tqdm $ python scripts/download_heartbeats.py --api_key API_KEY [--url URL] [--from FROM] [--to TO] [--output OUTPUT] ``` <details> <summary>Example</summary> ```bash python scripts/download_heartbeats.py --api_key 04648d14-15c9-432b-b901-dbeec70d4eaf \ --url https://wakapi.dev/api \ --from 2023-01-01 \ --to 2023-01-31 \ --output wakapi_export.csv ``` </details> ## 👍 Best practices It is recommended to use wakapi behind a **reverse proxy**, like [Caddy](https://caddyserver.com) or [nginx](https://www.nginx.com/), to enable **TLS encryption** (HTTPS). However, if you want to expose your wakapi instance to the public anyway, you need to set `server.listen_ipv4` to `0.0.0.0` in `config.yml`. ## 🧪 Tests ### Unit tests Unit tests are supposed to test business logic on a fine-grained level. They are implemented as part of the application, using Go's [testing](https://pkg.go.dev/testing?utm_source=godoc) package alongside [stretchr/testify](https://pkg.go.dev/github.com/stretchr/testify). #### How to run ```bash $ go install github.com/mfridman/tparse@latest # optional $ CGO_ENABLED=0 go test -json -coverprofile=coverage/coverage.out ./... -run ./... | tparse -all ``` ### API tests API tests are implemented as black box tests, which interact with a fully-fledged, standalone Wakapi through HTTP requests. They are supposed to check Wakapi's web stack and endpoints, including response codes, headers and data on a syntactical level, rather than checking the actual content that is returned. Our API (or end-to-end, in some way) tests are implemented as a [Bruno](https://www.usebruno.com/) collection and can be run either from inside Bruno, or using [Bruno CLI](https://www.npmjs.com/package/@usebruno/cli) as a command-line runner. To get a predictable environment, tests are run against a fresh and clean Wakapi instance with a SQLite database that is populated with nothing but some seed data (see [data.sql](testing/data.sql)). It is usually recommended for software tests to be [safe](https://www.restapitutorial.com/lessons/idempotency.html), stateless and without side effects. In contrary to that paradigm, our API tests strictly require a fixed execution order (which Bruno assures) and their assertions may rely on specific previous tests having succeeded. #### Prerequisites (Linux only) ```bash # 1. sqlite (cli) $ sudo apt install sqlite # Fedora: sudo dnf install sqlite # 2. bruno cli $ npm install -g @usebruno/cli ``` #### How to run (Linux only) ```bash $ ./testing/run_api_tests.sh ``` ## 🤓 Developer notes ### Building web assets To keep things minimal, all JS and CSS assets are included as static files and checked in to Git. [TailwindCSS](https://tailwindcss.com/docs/installation#building-for-production) and [Iconify](https://iconify.design/docs/icon-bundles/) require an additional build step. To only require this at the time of development, the compiled assets are checked in to Git as well. ```bash $ yarn $ yarn build # or: yarn watch ``` New icons can be added by editing the `icons` array in [scripts/bundle_icons.js](scripts/bundle_icons.js). #### Precompression As explained in [#284](https://github.com/muety/wakapi/issues/284), precompressed (using Brotli) versions of some of the assets are delivered to save additional bandwidth. This was inspired by Caddy's [`precompressed`](https://caddyserver.com/docs/caddyfile/directives/file_server) directive. [`gzipped.FileServer`](https://github.com/muety/wakapi/blob/07a367ce0a97c7738ba8e255e9c72df273fd43a3/main.go#L249) checks for every static file's `.br` or `.gz` equivalents and, if present, delivers those instead of the actual file, alongside `Content-Encoding: br`. Currently, compressed assets are simply checked in to Git. Later we might want to have this be part of a new build step. To pre-compress files, run this: ```bash # Install brotli first $ sudo apt install brotli # or: sudo dnf install brotli # Watch, build and compress $ yarn watch:compress # Alternatively: build and compress only $ yarn build:all:compress # Alternatively: compress only $ yarn compress ``` ## ❔ FAQs Since Wakapi heavily relies on the concepts provided by WakaTime, [their FAQs](https://wakatime.com/faq) largely apply to Wakapi as well. You might find answers there. <details> <summary>What data are sent to Wakapi?</summary> <ul> <li>File names</li> <li>Project names</li> <li>Editor names</li> <li>Your computer's host name</li> <li>Timestamps for every action you take in your editor</li> <li>...</li> </ul> See the related [WakaTime FAQ section](https://wakatime.com/faq#data-collected) for details. If you host Wakapi yourself, you have control over all your data. However, if you use our webservice and are concerned about privacy, you can also [exclude or obfuscate](https://wakatime.com/faq#exclude-paths) certain file- or project names. </details> <details> <summary>What happens if I'm offline?</summary> All data are cached locally on your machine and sent in batches once you're online again. </details> <details> <summary>How did Wakapi come about?</summary> Wakapi was started when I was a student, who wanted to track detailed statistics about my coding time. Although I'm a big fan of WakaTime I didn't want to pay <a href="https://wakatime.com/pricing">$9 a month</a> back then. Luckily, most parts of WakaTime are open source! </details> <details> <summary>How does Wakapi compare to WakaTime?</summary> Wakapi is a small subset of WakaTime and has a lot less features. Cool WakaTime features, that are missing Wakapi, include: <ul> <li>Leaderboards</li> <li><a href="https://wakatime.com/share/embed">Embeddable Charts</a></li> <li>Personal Goals</li> <li>Team- / Organization Support</li> <li>Additional Integrations (with GitLab, etc.)</li> <li>Richer API</li> </ul> WakaTime is worth the price. However, if you only need basic statistics and like to keep sovereignty over your data, you might want to go with Wakapi. </details> <details> <summary>How are durations calculated?</summary> Inferring a measure for your coding time from heartbeats works similar to WakaTime, see their [docs](https://wakatime.com/faq#timeout). Traditionally, Wakapi used to _pad_ every heartbeat before a `<timeout>`-long break with a padding of 2 minutes by default. Now, after the refactoring addressed in [#675](https://github.com/muety/wakapi/issues/675), Wakapi's logic is prtty much the same as WakaTime's, including a manually configurable timeout (default is 10 minutes). Here is an example (circles are heartbeats): ```text |---o---o--------------o---o---| | |10s| 3m |10s| | ``` It is unclear how to handle the three minutes in between. Did the developer do a 3-minute break, or were just no heartbeats being sent, e.g. because the developer was staring at the screen trying to find a solution, but not actually typing code? <ul> <li>With 10 min timeout:: 3 min 20 sec <li>With 2 min timeout: 20 sec <li>Previously (with 2 min timeout + padding): 10 sec + 2 min + 10 sec = 2 min 20 sec</li> </ul> </details> See [this comment](https://github.com/muety/wakapi/issues/716#issuecomment-2668887035) for another example. ## 👥 Community contributions * 💻 [Code] Image generator from Wakapi stats – [LacazeThomas/wakapi-stats](https://github.com/LacazeThomas/wakapi-stats) (`Go`) * 💻 [Code] Discord integration for Wakapi - [LLoneDev6/Wakapi-Discord](https://github.com/LoneDev6/Wakapi-Discord) (`JavaScript`) * 💻 [Code] Alternative heartbeats export script - [wakapiexporter.nim](https://github.com/theAkito/mini-tools-nim/tree/master/generic/web/wakapiexporter) (`Nim`) * 💻 [Code] Wakapi Helm chart for K8s deployments - [andreymaznyak/wakapi-helm-chart](https://github.com/andreymaznyak/wakapi-helm-chart) (`YAML`) * 🗒 [Article] [Wakamonth: hours reporting tool](https://bitstillery.com/2024/01/09/wakamonth-hours-reporting-tool/) ## 👏 Support Coding in open source is my passion, and I would love to do it on a full-time basis and make a living from it one day. So if you like this project, please consider supporting it 🙂. You can donate either through [buying me a coffee](https://buymeacoff.ee/n1try) or becoming a GitHub sponsor. Every little donation is highly appreciated and boosts my motivation to keep improving Wakapi! ## 🙏 Thanks I highly appreciate the efforts of **[@alanhamlett](https://github.com/alanhamlett)** and the WakaTime team and am thankful for their software being open source. Moreover, thanks to **[server.camp](https://server.camp)** for donating server infrastructure for Wakapi.dev. <div> <img src=".github/assets/servercamp_logo.png" width="200px" /> </div> ## 📓 License MIT @ [Ferdinand Mütsch](https://muetsch.io)

Time Tracking

4.3K Github Stars

telepush

<img src="views/static/logo.svg" height="200"> <h1 align="center">Telepush</h1> <h3 align="center">Send Telegram push notifications easily via HTTP</h3> <img src="https://badges.fw-web.space/github/license/muety/telepush"> <a href="mailto:[email protected]?subject=Thanks for creating Telepush" target="_blank"><img src="https://badges.fw-web.space/badge/say%20thanks-%F0%9F%99%8F-%23159CE4"></a> <a href="https://wakapi.dev" target="_blank"><img src="https://badges.fw-web.space/endpoint?url=https://wakapi.dev/api/compat/shields/v1/n1try/interval:any/project:telepush&color=blue"></a> <a href="https://sonarcloud.io/dashboard?id=muety_telegram-middleman-bot"><img src="https://sonarcloud.io/api/project_badges/measure?project=muety_telegram-middleman-bot&metric=security_rating"></a> --- ## 📄 Description A simple [Telegram Bot](https://t.me/MiddleManBot) to translate `POST` requests with JSON payload into Telegram push messages. Similar [Gotify](https://gotify.net/) and [ntfy.sh](https://ntfy.sh/), except without an extra app. Useful for server monitoring, alerting, and anything else. ## ⌨️ How to use? ### Step 1: Get a token Open Telegram, start a chat with the [TelepushBot](https://t.me/MiddleManBot) (or your own bot, respectively) and type `/start` to obtain a recipient token. ### Step 2: Send messages Messages are sent via `POST` to **`https://telepush.dev/api/[[inlets/<inlet_name>]|messages]/<recipient>`**. ```bash RECIPIENT_TONEN=... # The token you received using /start. curl -XPOST \ -H 'Content-Type: application/json' \ -d '{ "text": "*Hello World!* (yes, this is Markdown)" }' \ "https://telepush.dev/api/messages/${RECIPIENT_TONEN}" ``` When hosting your own instance, replace the URL respectively. ### ✉️ Message options | **Key** | **Type** | **Description** | |-------------------------------------|------------------|-------------------------------------------------------------| | **`text`*** | string | Actual message in plain text or Markdown format | | **`origin`** | string | What will be shown as the sender of your message | | **`type`** | [`TEXT`, `FILE`] | Message type, i.e. to send text or a file (default: `TEXT`) | | **`file`**** | base64 | Base64-encoded file content | | **`filename`**** | string | Name of the file to send | | **`options`** | object | Additional options to pass | | **`options.disable_link_previews`** | bool | Whether to show previews of links in the chat | `*` = required for `type: TEXT`, `**` = required for `type: FILE` More details to be found [here](/inlets). ## 🏃‍♀️ How to run? ### ☁️ Option 1: [telepush.dev](https://telepush.dev) Simply use the official hosted instance. Rate-limited to 240 requests per recipient per day. ### 🌐 Option 2: Self-hosted When hosting your own Telepush instance, you need to create a new bot with [@BotFather](https://t.me/BotFather) first. As a result, you will get a token that you then pass to Telepush when starting the server (see below). #### 🐳 Option 2.1: With Docker ```bash $ docker volume create telepush_data $ docker run -d \ -p 8080:8080 \ -v telepush_data:/srv/data \ --name telepush \ ghcr.io/muety/telepush \ -mode webhook \ -token <YOUR_BOTFATHER_TOKEN> ``` #### 🐋 Option 2.2: With Kubernetes See [here](https://github.com/muety/telepush/issues/68#issue-2073400161). #### 🛠 Option 2.3: Compile from source ```bash # Install $ go install github.com/muety/telepush@latest # Run (webhook mode) $ ./telepush -token <YOUR_BOTFATHER_TOKEN> -mode webhook ``` #### ↔️ Webhook vs. long-polling You can either run the bot in long-polling- or webhook mode (`-mode [webhook|poll]`). For production use the latter option is recommended for [various reasons](https://core.telegram.org/bots/webhooks). However, you'll need a server with a static IP and a TLS certificate. More details about webhook setup can be found in [__Marvin's Marvellous Guide to All Things Webhook__](https://core.telegram.org/bots/webhooks). #### 🔓 HTTPS In webhook mode, Telegram requires your [updates endpoint](https://core.telegram.org/bots/api#getting-updates) to use HTTPS. To enable such, either run Telepush **behind a reverse proxy** (like [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy)), that terminates TLS. Or, let Telepush itself handle TLS. You'll need a **certificate** for this, so either get one from [Let's Encrypt](https://letsencrypt.org/) or [create a self-signed one](https://www.linode.com/docs/guides/create-a-self-signed-tls-certificate/), then use `-useHttps` in combination with `-certPath` and `-keyPath` pointed to your certificate and private key files respectively. For self-signed certificates, you'll need to pass your public key to Telegram's `setWebhook` method in addition, see [these instructions](https://core.telegram.org/bots/webhooks#how-do-i-set-a-webhook-for-either-type). ## 🔧 Configuration options * `-address` (`string`) – Network address (IPv4) to bind to. Defaults to `127.0.0.1`. * `-address6` (`string`) – Network address (IPv6) to bind to. Defaults to `::1`. * `-disableIPv6` (`bool`) – Whether to disable listening on both IPv4 and IPv6 interfaces. Defaults to `false`. * `-port` (`int`) – TCP port to listen on. Defaults to `8080`. * `-proxy` (`string`) – Proxy connection string to be used for long-polling mode. Defaults to none. * `-urlSecret` (`string`) – Random suffix to append to your updates route called by Telegram's servers to prevent spam. Defaults to none. * `-useHttps` (`bool`) – Whether to use HTTPS. Defaults to `false`. * `-certPath` (`string`) – Path of your SSL certificate when using webhook mode with `useHttp`. Default to none. * `-keyPath` (`string`) – Path of your private SSL key when using webhook mode with `useHttp`. Default to none. * `-dataDir` (`string`) – File system location where to store persistent data. Defaults to `.`. * `-inlets` (`string`) – Path to folder containing config-based inlet definitions in YAML format. Defaults to `./inlets.d`. * `-blacklist` (`string`) – Path to a line-separated blacklist file containing user IDs (send `/help` to get your id). Defaults to `blacklist.txt`. * `-whitelist` (`string`) – Path to a line-separated whitelist file containing user IDs (send `/help` to get your id). Defaults to `whitelist.txt`. * `-rateLimit` (`int`) – Maximum number of messages to be delivered to each recipient per hour. Defaults to `100`. * `-truncateMsgs` (`bool`) – Truncate too long messages to 4096 characters instead of rejecting them. Defaults to `false`. * `-metrics` (`bool`) – Whether to expose [Prometheus](https://prometheus.io) metrics under `/metrics`. Defaults to `false`. When using the Docker image, you can alternatively set most of the above config options via **environment variables** (passed to `docker run` using `-e`), e.g. `APP_USE_HTTPS=true`, `APP_CERT_PATH=/etc/telepush.crt`, etc. For details, see [`entrypoint.sh`](docker/entrypoint.sh). ### Whitelist vs. Blacklist (aka. allow-list vs. block-list) <img src=".github/message-accept.svg" width="600px"> ## 📥 Inlets Inlets provide a mechanism to pre-process incoming data that comes in a format different from what is normally expected by the bot. This is especially useful if data is sent by external, third-party applications which you cannot modify. For instance, you might want to deliver alerts from [Prometheus' Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) as Telegram notifications. However, Alertmanager's [webhook requests](https://prometheus.io/docs/alerting/configuration/#webhook_config) look much different from Telepush's default input format. To still make them fit, you can write an [Inlet](/inlets) to massage the data accordingly. To directly address an inlet, request `https://telepush.dev/api/inlets/<inlet_name>`. Note that `/api/inlets/default` is equivalent to `/api/messages`. Following inlets are currently available: | Name | Description | Status | |----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| | `default` | Simply passes the request through without any changes | ✅ | | `alertmanager` | Consumes [Alertmanager webhook requests](https://prometheus.io/docs/alerting/configuration/#webhook_config) | ✅ | | `grafana` | Consumes [Grafana webhook requests](https://grafana.com/docs/grafana/latest/alerting/contact-points/notifiers/webhook-notifier/) | ✅ | | `webmentionio` | Accepts [Webmention.io](https://webmention.io/) webhook requests to notify about a new Webmention of one of your articles | ✅ | | `stripe` | Accepts [Stripe webhooks](https://docs.stripe.com/webhooks) to notify about subscription status changes | ✅ | | `bitbucket` | Accepts [Bitbucket webhook requests](https://confluence.atlassian.com/bitbucket/tutorial-create-and-trigger-a-webhook-747606432.html) to notify about a pipeline status change | ⏳ | You can also **define your own, custom inlets** in YAML. Further documentation on this and about the individual pre-existing inlets is available [here](/inlets). For all inlets, the following options are available to be passed as query parameters: | Parameter | Description | |-------------------------|-----------------------------------------------------------------------------------| | `disable_link_previews` | Disable a preview version of web links detected in the message. Default: `false`. | | `disable_markdown` | Disable the message being attempted to be parsed as Markdown. Default: `false`. | Example: `POST https://telepush.dev/api/inlets/default?disable_markdown=true&disable_link_previews=true`. ## 📊 Metrics Fundamental [Prometheus](https://prometheus) metrics are exposed under `/metrics`, if the `-metrics` flag gets passed. They include: * `telepush_messages_total{origin="string", type="string"}` * `telepush_requests_total{success="string"}` ## 🐞 Troubleshooting ### Error: `panic: template: pattern matches no files: *.tpl.html` When running Telepush as a single executable, you **must not use dev mode** unless Telepush's source code is located inside the same directory. Make sure to not pass `-env dev` in this case. ## 📓 License MIT @ [Ferdinand Mütsch](https://muetsch.io)

Communication Live Chat & Chatbots Internal Tools & Admin

534 Github Stars

Software by muety

Anchr

Wakapi

telepush