{"id":36705154,"url":"https://github.com/xordspar0/squirrelbot","last_synced_at":"2026-01-12T11:41:59.931Z","repository":{"id":73561610,"uuid":"91847836","full_name":"xordspar0/squirrelbot","owner":"xordspar0","description":"A Telegram bot that stashes away links that you send to it","archived":false,"fork":false,"pushed_at":"2018-09-11T20:11:14.000Z","size":108,"stargazers_count":1,"open_issues_count":12,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-11T04:46:10.712Z","etag":null,"topics":["bot","golang","telegram-bot"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xordspar0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-19T21:48:30.000Z","updated_at":"2024-03-15T21:05:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"fcb4a098-045b-4cd5-9260-b2a5c78fee90","html_url":"https://github.com/xordspar0/squirrelbot","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/xordspar0/squirrelbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xordspar0%2Fsquirrelbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xordspar0%2Fsquirrelbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xordspar0%2Fsquirrelbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xordspar0%2Fsquirrelbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xordspar0","download_url":"https://codeload.github.com/xordspar0/squirrelbot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xordspar0%2Fsquirrelbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338972,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T10:58:46.209Z","status":"ssl_error","status_checked_at":"2026-01-12T10:58:42.742Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["bot","golang","telegram-bot"],"created_at":"2026-01-12T11:41:59.855Z","updated_at":"2026-01-12T11:41:59.910Z","avatar_url":"https://github.com/xordspar0.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Squirrelbot\n===========\n\nSquirrelbot is a Telegram bot that saves links that you send it for viewing\nlater. Currently, it only saves Youtube videos and formats them for easy viewing\nin Kodi. On the roadmap are handling videos from other websites and saving\narbitrary links in a personal RSS feed.\n\nBuilding\n--------\n\nSquirrelbot is written in [Go](https://golang.org). You'll need the [Go\ntoolchain](https://golang.org/doc/install) to build the bot.\n\n### Dependencies\n\n[youtube-dl](https://rg3.github.io/youtube-dl/) is a runtime dependency. You\nshould be able to install it through your system package manager.\n\n### Build\n\nTo build squirrelbot, simply run `make` in the root directory. To install\nsquirrelbot, run `make install` as root.\n\nSome build options are available as `make` variables. You can change the system\nconfig file location, systemd unit file location, and others. Look at the\nMakefile for details.\n\nRunning\n-------\n\n### Telegram Token\n\nTo run this bot, you first need to get an API token from Telegram. The\ndirections for doing that are [here](https://core.telegram.org/bots).\n\nOnce you have your API token, run Squirrelbot with the required command-line\narguments:\n\n```sh\nsquirrelbot --address=http://myserver.example.com --port=80 \\\n  --token=\u003cyour Telegram token\u003e\n```\n\n### Ports\n\nI use a reverse proxy to forward traffic from port 443 to Squirrelbot's default\nport. You can also set up Squirrelbot directly on port 80 or 443. Just make sure\nto use the appropriate port for your url scheme:\n\n*\tPort 80 for http://\n*\tPort 443 for https://\n\n### Download Directory\n\nYou can optionally specify a directory to download the videos to with the\n`--dir` argument:\n\n```sh\nsquirrelbot --address=http://myserver.example.com --port=80 \\\n  --token=\u003cyour Telegram token\u003e --dir=\"Youtube Videos\"\n```\n\n### MOTD\n\nIf you want Squirrelbot to respond to \"/start\" messages (which is a commonly\nused phrase for starting conversations with Telegram bots), you should set the\nmotd (message of the day) flag:\n\n```sh\nsquirrelbot --address=http://myserver.example.com --port=80 \\\n  --token=\u003cyour Telegram token\u003e --motd=\"Hello! Try sending me a link.\"\n```\n\n### Configuration with a YAML file\n\nAll command line options can also be set in a YAML config file (command line\noptions override config file options). By default, Squirrelbot looks for the\nconfig file at `/etc/squirrelbot/config.yaml`\n\nHere is an example config file:\n\n```yaml\naddress: https://myserver.example.com\nport: 80\ntoken: \u003cyour Telegram token\u003e\ndirectory: Youtube Videos\nmotd: Hello! Try sending me a link.\n```\n\nTips\n----\n\n### Transfering Video Files\n\nSquirrelbot downloads videos to a local directory that can be specified with the\n`--dir` option. The videos are formatted to be easy to view in Kodi. If you run\nthis bot on a different server than your Kodi/media server, you will want to\ntransfer your video files to your Kodi or media server box. Here are a couple\nways to do that.\n\n#### Sync with rsync\n\n*\tOn the receiving end, set up an rsync daemon that allows write-only access\n\tto the right directory.\n*\tOn the sending end, write a simple script that uses `inotifywait` to copy\n\tfiles via rsync.\n*\tOptionally, after the file is successfully send, the script should delete\n\tthe file from the server.\n\n#### Sync with Syncthing\n\nYou can use Syncthing to send video files to their final destination.\nSee https://docs.syncthing.net/intro/getting-started.html for instructions.\n\nLicense\n-------\n\nCopyright © 2017-2018 Jordan Christiansen.\n\nSquirrelbot is distributed under the terms of the GNU GPL version 3 or later.\nThis is free software: you are free to change and redistribute it. There is\nNO WARRANTY, to the extent permitted by law.\n\nThe full text of the GPL version 3 is in the file LICENSE. For more\ninformation, visit http://gnu.org/licenses/gpl.html.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxordspar0%2Fsquirrelbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxordspar0%2Fsquirrelbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxordspar0%2Fsquirrelbot/lists"}