[{"_1":2,"_195":-5,"_196":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_168":169},"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,"_159":-5,"_160":11,"_161":21,"_162":11,"_163":-5,"_164":11,"_165":-5,"_166":167},"canonicalUrl","https://hub.docker.com/r/mosswill/osmond/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","mosswill","reponame","osmond","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","Web servers","slug","web-servers","content_types",[49],"image","date_registered","2023-11-28T00:30:09.25675Z","description","Self-hostable alternative to EmailThis. Send ad-free pages and articles to your email inbox","is_private","last_updated","2023-11-29T13:37:45.587333Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[61],"application/vnd.oci.image.index.v1+json","pull_count",348,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

Osmond

Self-hostable alternative to EmailThis

\n\n\n## Introduction\n\nOsmond is a small, simple, and self-hostable service that enables you to send ad-free pages and articles to your email inbox. It is an attempt at recreating the [EmailThis](https://www.emailthis.me/) service from scratch, while making it open and free for everyone to use.\n\n\n## Features\n\nOsmond has all these features implemented :\n- Page article's extraction and sending as HTML by email\n- PDF conversion and sending as attachment by email\n- Automatic / Dynamically Personalized email subject\n- Called via a (generated and displayed) bookmarklet\n- Support for multiple email recipients\n- Support for extensive configuration with `.env`\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\n## Examples\n\n### Deploy with Docker\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 Osmond 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 Osmond as a front-facing service on port 80, with environment variables supplied as a `.env` file mounted as a volume.\n\n- `docker-compose.gotenberg.yml`: Run Osmond as a front-facing service on port 80, with a companion Gotenberg container running to convert pages into PDF files before being sent by email.\n\n- `docker-compose.ssl.yml`: Run Osmond 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 Osmond 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 Osmond in the current terminal (useful for debugging)\ndocker-compose up\n\n# Run Osmond in a detached terminal (most common)\ndocker-compose up -d\n\n# Show the logs written by Osmond (useful for debugging)\ndocker logs \n```\n\n### Deploy as a standalone application\n\nDeploying Osmond 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/osmond\ncd osmond\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 osmond main.go\n\n# Option 1 : Run Osmond in the current terminal\n./osmond\n\n# Option 2 : Run Osmond as a background process\n./osmond &\n\n# Option 3 : Run Osmond using screen\nscreen -S osmond\n./osmond\n \n```\n\n## Configuration\n\nTo run Osmond, 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_ENABLED` | `boolean` | Whether HTTPS should be used in place of HTTP. When configured, Osmond will look for `certificate.pem` and `key.pem` next to the executable for configuring SSL. Note that if Osmond is behind a proxy that already handles SSL, this should be set to `false`. | False |\n| `SERVER_HOST` | `string` | The remote host used to reach Osmond from the outside, including the protocol, and without trailing slash. (e.g. http://your-server.tld) | http://localhost |\n| `SERVER_PORT` | `integer` | The port Osmond listens on. | 80 |\n| `SERVER_SECRET` | `string` | The secret used to secure your Osmond instance against bots / malicious usage. | one-very-long-and-mysterious-secret |\n| `SERVER_PROXIED` | `boolean` | Whether Osmond sits behind a proxy. | False |\n| `SERVER_PROXY_PORT` | `integer` | The port used by the front-facing proxy. | None |\n| `DOWNLOAD_USER_AGENT` | `string` | The user agent Osmond should use when downloading remote pages before sending them by email | Chrome's default user agent on Mac |\n| `DOWNLOAD_CONVERT_PDF` | `boolean` | Whether Osmond should convert pages to PDF and send them by email afterwards. (Requires a Gotenberg instance) | False |\n| `DOWNLOAD_FORCE_READER` | `boolean` | By default, Gotenberg will turn the full web page into PDF. When set to `true`, this setting will make Gotenberg use the `Reader mode` version of the page to convert it, instead of using the whole page with ads and distraction. | False |\n| `SMTP_HOST` | `string` | Your SMTP host for sending emails | None |\n| `SMTP_PORT` | `integer` | Your SMTP port | None |\n| `SMTP_USERNAME` | `string` | Your SMTP username | None |\n| `SMTP_PASSWORD` | `string` | Your SMTP password | None |\n| `SMTP_FROM` | `string` | The email address to send the emails from. | Uses `SMTP_FROM` value |\n| `GOTENBERG_HOST` | `string` | The host used to reach Gotenberg's instance, without protocol. | None |\n| `GOTENBERG_PORT` | `integer` | The port used to reach Gotenberg's instance | None |\n| `EMAIL_AUTO_SUBJECT` | `boolean` | Whether Osmond should automatically set the emails' subject using the pages' metadata. (Current format : %SITE_NAME% - %PAGE_TITLE% ) | True |\n| `EMAIL_FORCE_SUBJECT` | `string` | The subject to use in place of the automatically generated one. Will only work if `EMAIL_AUTO_SUBJECT` is set to `false`. Supports templating, example: \"T:\\ --- \\ --- \\\" | None |\n| `SKIP_VERIFICATIONS` | `boolean` | Whether Osmond should skip startup verification checks before running the HTTP(S) server. | False |\n| `SHOW_BOOKMARKLET` | `boolean` | Whether Osmond should show the bookmarklet's snippet at startup | 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 use the `email+folder@domain.tld` notation to automatically put your pages in a dedicated folder of your email inbox.\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\n## API Reference\n\nOsmond exposes the following API :\n\n#### Heartbeat\n\n```http\n GET /heartbeat\n```\n```http\n .\n```\n\n#### Get the bookmarklet template\n\n```http\n GET /bookmarklet\n```\n```javascript\njavascript:l=document.location.href,s=\"\",r=encodeURIComponent(\"\"),xhr=new XMLHttpRequest,xhr.open(\"POST\",\":/relay\"),xhr.setRequestHeader(\"Content-Type\",\"application/x-www-form-urlencoded\"),xhr.send(\"secret=\"+s+\"&recipient=\"+r+\"&link=\"+l);\n```\n\n#### Get the actual bookmarklet code for your instance\n\n```http\n POST /bookmarklet\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :-------------------------------- |\n| `secret` | `string` | **Required.** Your server secret |\n| `recipient` | `string`| **Required.** The email to send the pages / PDF to (can be a list of comma-separated emails). |\n\n\n> **Note :** POST data should be sent in the body, using `x-www-form-urlencoded` format.\n\n#### Send a page by email\n\n```http\n POST /relay\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :-------------------------------- |\n| `secret` | `string` | **Required.** Your server secret |\n| `recipient` | `string`| **Required.** The email to send the pages / PDF to (can be a list of comma-separated emails). |\n| `link` | `string` | **Required.** The link of the page to download and send by email (should be an HTTPS url).\n\n> **Note :** POST data should be sent in the body, using `x-www-form-urlencoded` format.\n\n> **Note :** Most often, Osmond returns nothing more than a status code\n\n\n## Troubleshoot\n\nShould you encounter any issue running Osmond, 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#### Osmond is unreachable over HTTP / HTTPS\n\nPlease make sure that the following requirements are met :\n\n- If Osmond runs as a standalone application without proxy :\n - Make sure your server / firewall accepts incoming connections on Osmond's port.\n - Make sure your DNS configuration is correct. (Usually, such record should suffice : `A osmond XXX.XXX.XXX.XXX` for `https://osmond.your-server-tld`)\n - Make sure your `.env` file is well configured according to the [Configuration](#configuration) section.\n\n- If osmond runs behind Docker / a proxy :\n - Perform the previous (standalone) verifications first.\n - Make sure that `SERVER_PORT` (Osmond's port) and `SERVER_PROXY_PORT` (the proxy's port) are well set in `.env`.\n - Check your proxy forwarding rules.\n\nIn any case, the crucial part is [Configuration](#configuration).\n\n\n#### When I click on the bookmarklet, nothing happens\n\nThe current bookmarklet implementation just works, and won't display any confirmation message. The confirmation that everything works will be in your email inbox.\n\nNow, if no email is received, you should check your browser's developer console, especially the `Network` and `Console` tabs. If an error occurs, it will show in the `Console`. You can start debugging / opening an issue from there.\n\nMost often, the problem comes from a `Content Security Policy` set on the website you're browsing. Unfortunately, this effectively blocks the bookmarklet (although the specification for that feature states explicitly that bookmarklet shouldn't be blocked). The only ways to fix that is to either disable the `Content Security Policy` feature in your browser (not recommended), or creating a browser extension that bypasses it. (Let me know if that should be added to Osmond's roadmap!)\n\n\n#### I lost my bookmarklet, how to get it back?\n\nYou've got multiple ways to get your bookmarklet back :\n- Perform a `GET /bookmarklet` request on Osmond. It will display a bookmarklet template to fill in with you secret and email recipient.\n- Perform a `POST /bookmarklet` request on Osmond, providing `secret` and `recipient` in the body. It will display a complete bookmarklet.\n- Run `docker logs ` on your Osmond container. You should see your bookmarklet's template if you enabled `SHOW_BOOKMARKLET` environment variable.\n\n\n#### Osmond fails to download my page\n\nMany reasons could explain that, but most often it boils down to :\n- Your page is protected (behind a login screen, or behind a captcha, or behind a VPN, or else).\n- Your page is too big (you may need to adjust your server settings or your Gotenberg instance if you have PDF conversion enbled).\n- Your page is loaded as a part of a Single Page Application that can't fully load without a full-functioning headless browser.\n\nPlease note that Osmond isn't (yet?) able to download protected pages, as that would require impersonating you.\n\n#### How to send a page to my instance?\n\nYou're free to use the tool / app of your choice, and any HTTP client will do.\nNow, most certainly, you'd want to go with a bookmarklet. You can create one in your browser by creating a regular bookmark, and copy-paste Osmond's bookmarklet in the `URL` parameter. Now, when clicking on the bookmark in your browser, Javascript will perform a POST request to your instance, hence triggering the page-to-email procedure.\n\n\n#### Something else\n\nPlease feel free to open an issue, explaining what happens, and describing your environment.\n\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- [Gotenberg](https://github.com/gotenberg/gotenberg) : For the HTML to PDF conversion.\n- [go-readability](https://github.com/go-shiori/go-readability) : For the page's article extraction.\n- The countless others!\n\nAnd don't forget to mention Osmond if you like it or if it helps you in any way!","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",44258850,"orgData","recentTags",[95],{"_96":49,"_97":98,"_99":100,"_101":102,"_103":104,"_105":106,"_55":148,"_149":98,"_150":33,"_151":61,"_43":152,"_153":154,"_155":114,"_156":148,"_157":70,"_158":21},"content_type","creator",24097822,"digest","sha256:29cb799d85c298767765c4b64b0262bef60e706637636d4eb256e6188f24dc9c","full_size",15058453,"id",556235707,"images",[107,124,128,134,140,144],{"_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:7107aa4aee3b16d941ca5fd4f6c585282600d67d2e94ccbc0357a84ade2cae22","features","","last_pulled","2026-09-30T19:57:36.958582165Z","last_pushed","2023-11-28T00:38:41Z","os","linux","os_features","os_version","size",16552521,"variant",{"_108":125,"_99":126,"_111":112,"_113":127,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":102,"_67":70,"_123":-5},"arm64","sha256:6d397b801d408be425e3fcb6c77becadc6393b13c87a5bcd001a4536a6572b2a","2026-09-11T11:07:27.240051203Z",{"_108":129,"_99":130,"_111":112,"_113":131,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":132,"_67":70,"_123":133},"arm","sha256:c5800cfc57f9ed0d3fbe2dd64ba922c67aed7dcd66e51fdfb1475d418a3cd260","2026-09-11T11:07:27.23043607Z",14339430,"v7",{"_108":135,"_99":136,"_111":112,"_113":137,"_115":138,"_117":135,"_119":112,"_120":-5,"_121":139,"_67":70,"_123":-5},"unknown","sha256:2f0255d9372b02b5e80304f281c43fa8df246085f7562af31e8663315174cc44","2026-09-11T11:07:27.214848382Z","2023-11-29T13:37:43Z",1282,{"_108":135,"_99":141,"_111":112,"_113":142,"_115":143,"_117":135,"_119":112,"_120":-5,"_121":139,"_67":70,"_123":-5},"sha256:860f82668665304f33ed757c94efb32a0236ea5add247fc6e4eecc3686fe6267","2026-09-11T11:07:27.383469735Z","2023-11-29T13:37:44Z",{"_108":135,"_99":145,"_111":112,"_113":146,"_115":143,"_117":135,"_119":112,"_120":-5,"_121":147,"_67":70,"_123":-5},"sha256:63ba0fad6d5b8b536541e323ada03ffda5d63681571c92e047dccb4cd85d96ff","2026-09-11T11:07:27.415474739Z",1291,"2023-11-29T13:37:45.022019Z","last_updater","last_updater_username","media_type","latest","repository",22565981,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_38":170,"_178":179,"_166":193,"_194":11},{"_40":171,"_47":173,"_50":51,"_52":53,"_54":11,"_55":56,"_57":58,"_59":174,"_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":175,"_83":11,"_84":177,"_89":33,"_90":91},[172],{"_43":44,"_45":46},[49],[61],{"_79":11,"_80":176},[82],{"_86":21,"_87":11,"_88":11},"tags",{"_180":68,"_181":-5,"_182":-5,"_183":184},"count","next","previous","results",[185],{"_96":49,"_97":98,"_99":100,"_101":102,"_103":104,"_105":186,"_55":148,"_149":98,"_150":33,"_151":61,"_43":152,"_153":154,"_155":114,"_156":148,"_157":70,"_158":21},[187,188,189,190,191,192],{"_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":116,"_117":118,"_119":112,"_120":-5,"_121":102,"_67":70,"_123":-5},{"_108":129,"_99":130,"_111":112,"_113":131,"_115":116,"_117":118,"_119":112,"_120":-5,"_121":132,"_67":70,"_123":133},{"_108":135,"_99":136,"_111":112,"_113":137,"_115":138,"_117":135,"_119":112,"_120":-5,"_121":139,"_67":70,"_123":-5},{"_108":135,"_99":141,"_111":112,"_113":142,"_115":143,"_117":135,"_119":112,"_120":-5,"_121":139,"_67":70,"_123":-5},{"_108":135,"_99":145,"_111":112,"_113":146,"_115":143,"_117":135,"_119":112,"_120":-5,"_121":147,"_67":70,"_123":-5},[],"canDeleteTags","actionData","errors"]

Digest	OS/ARCH	Compressed size
7107aa4aee3b	linux/amd64	15.79 MB
c5800cfc57f9	linux/arm/v7	13.68 MB
6d397b801d40	linux/arm64	14.36 MB

mosswill/osmond

Tags for mosswill/osmond