{"id":19712155,"url":"https://github.com/fmstrat/traccar-notifier","last_synced_at":"2025-04-29T18:30:51.244Z","repository":{"id":42985179,"uuid":"208087837","full_name":"Fmstrat/traccar-notifier","owner":"Fmstrat","description":"A node app/docker container to enable push notifications from Traccar to multple platforms.","archived":false,"fork":false,"pushed_at":"2022-12-11T07:39:08.000Z","size":349,"stargazers_count":11,"open_issues_count":7,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-05T18:52:03.307Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Pug","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Fmstrat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-12T15:48:34.000Z","updated_at":"2022-12-11T06:52:00.000Z","dependencies_parsed_at":"2023-01-26T18:16:23.558Z","dependency_job_id":null,"html_url":"https://github.com/Fmstrat/traccar-notifier","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fmstrat%2Ftraccar-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fmstrat%2Ftraccar-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fmstrat%2Ftraccar-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Fmstrat%2Ftraccar-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Fmstrat","download_url":"https://codeload.github.com/Fmstrat/traccar-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251559750,"owners_count":21609067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T22:15:30.187Z","updated_at":"2025-04-29T18:30:50.879Z","avatar_url":"https://github.com/Fmstrat.png","language":"Pug","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Traccar Notifier\n\nTraccar Notifier is a node app/docker container to enable push notifications from Traccar to multple platforms.\n\nCurrently supported platforms:\n- Pushover\n- Telegram\n\n\u003cimg src=\"screenshots/1.jpg\" border=1 width=300\u003e\n\n## Usage\n\nTo use Traccar Notifier, include the following two lines in your `traccar.xml` file after using the directions from https://hub.docker.com/r/traccar/traccar:\n```\n    \u003centry key=\"event.forward.enable\"\u003etrue\u003c/entry\u003e\n    \u003centry key='event.forward.url'\u003ehttp://traccar-notifier:3080/api/v1\u003c/entry\u003e\n```\n\nNext, copy the `config.yml` file out of the container:\n```\nmkdir -p ./traccar-notifier\ndocker run \\\n\t--rm \\\n\t--entrypoint cat \\\n\tnowsci/traccar-notifier:latest \\\n\t/app/config.yml \u003e ./traccar-notifier/config.yml\n```\n\nYou will now have a config file like the following, edit the file to your liking, for instance:\n``` yml\nnotifiers:\n\n  pushover:\n    enabled: true\n    send_lowest_priority_on_disabled: false\n    user: fdfa903af04gjdfkadsf93fafjfie9\n    token: kafaaf9390efaffslepea09dsf9fkf\n\n  telegram:\n    enabled: true\n    chat_id: 999999999\n    token: 999999999:Afifefaadoieoaaa_aefFEFFDfjadfkaeee\n\nignore:\n\ntoken:\n```\nYou can enable more than one notifier, and all that are enabled will fire.\n\nYou could also have it ignore any notifications that have a specific string in the title, such as:\n``` yml\nignore:\n  - Device Online\n  - Device Unknown\n```\n\nYou can also enable a token required on the query string for accessing the system, then access the system via `http://traccar-notifier:3080/api/v1?token=THISISMYTOKEN`\n``` yml\ntoken: THISISMYTOKEN\n```\n\nLastly, use the following `docker-compose.yml` file for launching:\n```\nversion: '2'\n\nservices:\n\n  traccar:\n    image: traccar/traccar\n    container_name: traccar\n    hostname: traccar\n    ports:\n      - 80:8082\n      - 5000-5150:5000-5150\n      - 5000-5150:5000-5150/udp\n    volumes:\n      - /etc/localtime:/etc/localtime:ro\n      - ./traccar/data/logs:/opt/traccar/logs\n      - ./traccar/data/database:/opt/traccar/data\n      - ./traccar/config/traccar.xml:/opt/traccar/conf/traccar.xml:ro\n    restart: always\n\n  traccar-notifier:\n    image: nowsci/traccar-notifier\n    container_name: traccar-notifier\n    volumes:\n      - ./traccar-notifier/config.yml:/app/config.yml:ro\n    restart: always\n```\n\n## Altering configuration via the web\nAfter the system is deployed, you can enable/disable notifiers from `http://traccar-notifier:3080/` via a web browser. This does not change the configuration on disk, just what is in memory.\n\nIt is highly recommended to proxy behind SSL with `nginx` or `traefik`.\n\n## Usage outside of Docker\nIf you wish to use Traccar Notifier outside of docker, then go into the `src` folder, update the `config.yml` then run:\n```\nnpm install\nnpm start\n```\n\n## Adding notifiers\nAdding notifiers is accomplished by:\n- Adding a new `js` file into the `src/notifiers` folder. The `pushover.js` file can be used as an example.\n- Add a relevant configuration section in the `config.yml` file, with `enabled: false` and blank values.\n\nPRs are welcome!\n\n## Getting your Telegram Bot and Chat ID\n- Visit https://telegram.me/botfather\n- Send the following message to create a bot: `/newbot`\n- Use the token in the `config.yml`\n- Send a message to your bot to initiate a conversation\n- Visit https://telegram.me/get_id_bot\n- Send the following message to get your chat id: `/my_id`\n- Use the chat ID in the `config.yml`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmstrat%2Ftraccar-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffmstrat%2Ftraccar-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmstrat%2Ftraccar-notifier/lists"}