[{"_1":2,"_199":-5,"_200":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_172":173},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_92":-5,"_93":94,"_163":-5,"_164":11,"_165":21,"_166":11,"_167":-5,"_168":11,"_169":-5,"_170":171},"canonicalUrl","https://hub.docker.com/r/mosswill/bond/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","mosswill","reponame","bond","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_47":48,"_50":51,"_52":53,"_54":11,"_55":56,"_57":58,"_59":60,"_43":35,"_32":33,"_62":63,"_64":-5,"_65":66,"_67":68,"_69":70,"_71":-5,"_72":66,"_73":74,"_75":11,"_76":33,"_77":78,"_83":11,"_84":85,"_89":33,"_90":91},"categories",[42],{"_43":44,"_45":46},"name","API management","slug","api-management","content_types",[49],"image","date_registered","2024-05-04T23:39:42.741599Z","description","Self-hostable headless QR code generator","is_private","last_updated","2026-02-05T05:57:44.76024Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[61],"application/vnd.oci.image.index.v1+json","pull_count",13156,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

Bond

\n Self-hostable headless QR code generator\n
\n Generate QR codes with a one-endpoint API\n

\n\n## Introduction\n\nBond is a tiny, simple, and self-hostable service that enables you to generate QR codes by calling an API.\nIt was born out of a need to generate QR codes for my business when I couldn't find a fully free and secure API without limitations, along with Google shutting down their service.\nI also wanted something rudimentary without gimmicks or customization (colors, redirection, logo, shapes, etc.), hence I decided to make it myself.\n\n## Features\n\nBond has all these features implemented :\n- Generate a QR code of any size with any content\n- Simple security using a defined secret to deter bots\n- Support for HTTP and HTTPS\n- Support for standalone / proxy deployment\n\nOn top of these, one may appreciate the following characteristics :\n- Written in Go\n- Holds in a single file with few dependencies\n- Holds in a ~14 MB compressed Docker image\n\nFor more information, read about [Configuration](#configuration) and [API Reference](#api-reference).\n\n## Deployment and Examples\n\n### Deploy with Docker\n\nYou can run Bond with Docker on the command line very quickly.\n\nYou can use the following commands :\n\n```sh\n# Create a .env file\ntouch .env\n\n# Edit .env file ...\n\n# Option 1 : Run Bond attached to the terminal (useful for debugging)\ndocker run --env-file .env -p mosswill/bond\n\n# Option 2 : Run Bond as a daemon\ndocker run -d --env-file .env -p mosswill/bond\n```\n\n### Deploy with Docker Compose\n\nTo help you get started quickly, multiple example `docker-compose` files are located in the [\"examples/\"](examples) directory.\n\nHere's a description of every example :\n\n- `docker-compose.simple.yml`: Run Bond as a front-facing service on port 80., with environment variables supplied in the `docker-compose` file directly.\n\n- `docker-compose.volume.yml`: Run Bond as a front-facing service on port 80, with environment variables supplied as a `.env` file mounted as a volume.\n\n- `docker-compose.ssl.yml`: Run Bond as a front-facing service on port 443, listening for HTTPS requests, with certificate and private key provided as mounted volumes.\n\n- `docker-compose.proxy.yml`: A full setup with Bond running on port 80, behind a proxy listening on port 443, and Gotenberg running as well while not being exposed to external requests.\n\nWhen your `docker-compose` file is on point, you can use the following commands :\n```sh\n# Run Bond in the current terminal (useful for debugging)\ndocker-compose up\n\n# Run Bond in a detached terminal (most common)\ndocker-compose up -d\n\n# Show the logs written by Bond (useful for debugging)\ndocker logs \n```\n\n### Deploy as a standalone application\n\nDeploying Bond as a standalone application assumes the following prerequisites :\n- You have Go installed on your server\n- You have properly filled your `.env` file\n- Your DNS and networking configuration is on point\n\nWhen all the prerequisites are met, you can run the following commands in your terminal :\n\n```sh\n# Retrieve the code\ngit clone https://github.com/will-moss/bond\ncd bond\n\n# Create a new .env file\ncp sample.env .env\n\n# Edit .env file ...\n\n# Build the code into an executable\ngo build -o bond main.go\n\n# Option 1 : Run Bond in the current terminal\n./bond\n\n# Option 2 : Run Bond as a background process\n./bond &\n\n# Option 3 : Run Bond using screen\nscreen -S bond\n./bond\n \n```\n\n## Configuration\n\nTo run Bond, you will need to set the following environment variables in a `.env` file located next to your executable :\n\n> **Note :** Regular environment variables provided on the commandline work too\n\n| Parameter | Type | Description | Default |\n| :---------------------- | :-------- | :------------------------- | ------- |\n| `SSL` | `boolean` | Whether HTTPS should be used in place of HTTP. When configured, Bond will look for `certificate.pem` and `key.pem` next to the executable for configuring SSL. Note that if Bond is behind a proxy that already handles SSL, this should be set to `false`. | False |\n| `PORT` | `integer` | The port Bond listens on. | 80 |\n| `SECRET` | `string` | The secret used to secure your Bond instance against bots / malicious usage. (This parameter can be left empty to disable security) | a-very-long-and-complicated-secret |\n| `MAX_SIZE` | `integer` | The max size for your QR codes, in pixels, such that a QR code can never be greater than MAX_SIZE x MAX_SIZE pixels. | 1024 |\n| `RECOVERY_LEVEL` | `string` | The recovery level used to generate the QR codes. One of : Low, Medium, High, and Highest (case-insensitive). | Medium |\n| `ENABLE_LOGS` | `boolean` | Whether all the HTTP requests should be displayed in the console / logs. | TRUE |\n\n> **Note :** Boolean values are case-insensitive, and can be represented via \"ON\" / \"OFF\" / \"TRUE\" / \"FALSE\" / 0 / 1.\n\n> **Tip :** You can generate a random secret with the following command :\n\n```sh\nhead -c 1024 /dev/urandom | base64 | tr -cd \"[:lower:][:upper:][:digit:]\" | head -c 32\n```\n\n## API Reference\n\nBond exposes the following API, consisting of a single endpoint :\n\n#### Generate a QR code\n\n```\n GET /\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :-------------------------------- |\n| `secret` | `string` | **Required.** Your server secret (can be empty if your `SECRET` setting is empty). |\n| `size` | `string` | **Required.** The size (in pixels) of the QR code to generate. (The QR code will be size x size pixels.) |\n| `content` | `string` | **Required.** The data to encode in the QR code. |\n\nThe API will directly return the image representing the QR code generated using your settings.\n\n## Usage\n\nTo generate QR codes using Bond, you can copy and adapt the following examples :\n\n### curl\n\n```sh\ncurl -o qr-code.png \"https://bond.your-domain.tld/?content=YOUR-CONTENT&size=512&secret=YOUR-SECRET\"\n```\n\n### wget\n\n```sh\nwget -O qr-code.png \"https://bond.your-domain.tld/?content=YOUR-CONTENT&size=512&secret=YOUR-SECRET\"\n```\n\n### Javascript\n\n```javascript\nasync function to_qrcode(text) {\n const url = `https://bond.your-domain.tld/?` + new URLSearchParams({\n size: 512,\n content: text,\n secret: 'YOUR-SECRET'\n });\n let response = await fetch(url);\n\n if (response.status !== 200) {\n console.log('HTTP-Error: ' + response.status);\n return null;\n }\n\n const blob = await response.blob();\n const objectURL = URL.createObjectURL(blob);\n\n const image = document.createElement('img');\n image.src = objectURL;\n\n const container = document.getElementById('YOUR-CONTAINER');\n container.append(image);\n}\n\nawait to_qrcode(\"YOUR-CONTENT\");\n```\n\n## Troubleshoot\n\nShould you encounter any issue running Bond, please refer to the following common problems that may occur.\n\n> If none of these matches your case, feel free to open an issue.\n\n\n#### Bond is unreachable over HTTP / HTTPS\n\nPlease make sure that the following requirements are met :\n\n- If Bond runs as a standalone application without proxy :\n - Make sure your server / firewall accepts incoming connections on Bond's port.\n - Make sure your DNS configuration is correct. (Usually, such record should suffice : `A bond XXX.XXX.XXX.XXX` for `https://bond.your-server-tld`)\n - Make sure your `.env` file is well configured according to the [Configuration](#configuration) section.\n\n- If Bond runs behind Docker / a proxy :\n - Perform the previous (standalone) verifications first.\n - Make sure that `PORT` (Bond's port) is well set in `.env`.\n - Check your proxy forwarding rules.\n\nIn any case, the crucial part is [Configuration](#configuration).\n\n#### Bond returns an error 4xx instead of a QR code\n\nPlease make sure that :\n- You're using the `GET` HTTP method.\n- You've included the `secret` parameter, and the value of it equals the value of the `SECRET` defined in your `.env`.\n- The `size` you requested fits within the range 1 <= `size` <= `MAX_SIZE`.\n\n\n#### Something else\n\nPlease feel free to open an issue, explaining what happens, and describing your environment.\n\n## Credits\n\nHey hey ! It's always a good idea to say thank you and mention the people and projects that help us move forward.\n\nBig thanks to the individuals / teams behind these projects :\n- [go-qrcode](https://github.com/skip2/go-qrcode) : For the QR code generation.\n- [go-chi](https://github.com/go-chi/chi) : For the web server.\n- The countless others!\n\nAnd don't forget to mention Bond if you like it or if it helps you in any way!\n","has_starred","hub_user","immutable_tags_settings",{"_79":11,"_80":81},"enabled","rules",[82],".*","is_automated","permissions",{"_86":21,"_87":11,"_88":11},"read","write","admin","user","storage_size",122556172,"orgData","recentTags",[95],{"_96":49,"_97":98,"_99":100,"_101":102,"_103":104,"_105":106,"_55":151,"_152":98,"_153":33,"_154":61,"_43":155,"_156":157,"_158":159,"_160":151,"_161":70,"_162":21},"content_type","creator",24097822,"digest","sha256:94d6abf31949ab2dd47b86940719e5a48efe57e03aeb6d4b46569dace41a20f9","full_size",5858196,"id",657781096,"images",[107,124,129,136,142,146],{"_108":109,"_99":110,"_111":112,"_113":114,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":122,"_67":70,"_123":-5},"architecture","amd64","sha256:8a170547673561e443a5f325cd1da86919b10b2417a49cbb80fc844050923c93","features","","last_pulled","2026-09-30T16:03:26.586872628Z","last_pushed","2026-02-05T05:57:39.64898102Z","os","linux","os_features","os_version","size",6204964,"variant",{"_108":125,"_99":126,"_111":112,"_113":127,"_115":128,"_117":118,"_119":112,"_120":-5,"_121":102,"_67":70,"_123":-5},"arm64","sha256:203e738aa7d86c9ca0c60d543dc8bf2d9245aa27dea78a2ac6675da1eabb2493","2026-09-14T20:28:22.017482658Z","2026-02-05T05:57:37.36419741Z",{"_108":130,"_99":131,"_111":112,"_113":132,"_115":133,"_117":118,"_119":112,"_120":-5,"_121":134,"_67":70,"_123":135},"arm","sha256:1562819ddbfa29913c7ab22fb99fa6e2623b669ec3b6a856f939d367f2f2c0ae","2026-09-14T20:28:24.146227248Z","2026-02-05T05:57:38.460360558Z",5935974,"v7",{"_108":137,"_99":138,"_111":112,"_113":139,"_115":140,"_117":137,"_119":112,"_120":-5,"_121":141,"_67":70,"_123":-5},"unknown","sha256:3149f383fe2587a0937457f34889b36a8c93575f7d5c4eb666a68ae651536e8e","2026-09-14T20:28:55.834524728Z","2026-02-05T05:57:41.550104236Z",1348,{"_108":137,"_99":143,"_111":112,"_113":144,"_115":145,"_117":137,"_119":112,"_120":-5,"_121":141,"_67":70,"_123":-5},"sha256:818e6ba9b53a058ec532a270d49012d44ea91814732ced4f5c08adf6df2fa483","2026-09-25T14:43:52.502144304Z","2026-02-05T05:57:40.707503516Z",{"_108":137,"_99":147,"_111":112,"_113":148,"_115":149,"_117":137,"_119":112,"_120":-5,"_121":150,"_67":70,"_123":-5},"sha256:46a4bd3e9eb73eb28891c664c6d472059196f9832276d5bf0bf7e5ee70cb7cc9","2026-09-14T20:28:58.333920829Z","2026-02-05T05:57:42.283740964Z",1354,"2026-02-05T05:57:43.398742Z","last_updater","last_updater_username","media_type","latest","repository",24016185,"tag_last_pulled","2026-09-30T18:00:17.253481495Z","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_38":174,"_182":183,"_170":197,"_198":11},{"_40":175,"_47":177,"_50":51,"_52":53,"_54":11,"_55":56,"_57":58,"_59":178,"_43":35,"_32":33,"_62":63,"_64":-5,"_65":66,"_67":68,"_69":70,"_71":-5,"_72":66,"_73":74,"_75":11,"_76":33,"_77":179,"_83":11,"_84":181,"_89":33,"_90":91},[176],{"_43":44,"_45":46},[49],[61],{"_79":11,"_80":180},[82],{"_86":21,"_87":11,"_88":11},"tags",{"_184":68,"_185":-5,"_186":-5,"_187":188},"count","next","previous","results",[189],{"_96":49,"_97":98,"_99":100,"_101":102,"_103":104,"_105":190,"_55":151,"_152":98,"_153":33,"_154":61,"_43":155,"_156":157,"_158":159,"_160":151,"_161":70,"_162":21},[191,192,193,194,195,196],{"_108":109,"_99":110,"_111":112,"_113":114,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":122,"_67":70,"_123":-5},{"_108":125,"_99":126,"_111":112,"_113":127,"_115":128,"_117":118,"_119":112,"_120":-5,"_121":102,"_67":70,"_123":-5},{"_108":130,"_99":131,"_111":112,"_113":132,"_115":133,"_117":118,"_119":112,"_120":-5,"_121":134,"_67":70,"_123":135},{"_108":137,"_99":138,"_111":112,"_113":139,"_115":140,"_117":137,"_119":112,"_120":-5,"_121":141,"_67":70,"_123":-5},{"_108":137,"_99":143,"_111":112,"_113":144,"_115":145,"_117":137,"_119":112,"_120":-5,"_121":141,"_67":70,"_123":-5},{"_108":137,"_99":147,"_111":112,"_113":148,"_115":149,"_117":137,"_119":112,"_120":-5,"_121":150,"_67":70,"_123":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
8a1705476735	linux/amd64	5.92 MB
1562819ddbfa	linux/arm/v7	5.66 MB
203e738aa7d8	linux/arm64	5.59 MB

mosswill/bond

Tags for mosswill/bond