{"id":15141812,"url":"https://github.com/scribblerockerz/cryptletter","last_synced_at":"2025-10-10T15:11:17.551Z","repository":{"id":25722612,"uuid":"105050869","full_name":"Scribblerockerz/cryptletter","owner":"Scribblerockerz","description":"Self-hosted micro-service for encrypted self-destructing messages","archived":false,"fork":false,"pushed_at":"2024-04-17T19:23:17.000Z","size":51842,"stargazers_count":35,"open_issues_count":8,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-30T20:29:58.433Z","etag":null,"topics":["destructing-messages","docker-image","encrypted-data","golang","microservice"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Scribblerockerz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-27T17:55:47.000Z","updated_at":"2024-11-26T21:13:16.000Z","dependencies_parsed_at":"2024-06-19T01:21:16.261Z","dependency_job_id":null,"html_url":"https://github.com/Scribblerockerz/cryptletter","commit_stats":{"total_commits":95,"total_committers":4,"mean_commits":23.75,"dds":0.3894736842105263,"last_synced_commit":"585669d0edbd3341a4e197e4c069f15ede4faa1e"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scribblerockerz%2Fcryptletter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scribblerockerz%2Fcryptletter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scribblerockerz%2Fcryptletter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scribblerockerz%2Fcryptletter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Scribblerockerz","download_url":"https://codeload.github.com/Scribblerockerz/cryptletter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237869272,"owners_count":19379293,"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":["destructing-messages","docker-image","encrypted-data","golang","microservice"],"created_at":"2024-09-26T09:02:14.371Z","updated_at":"2025-10-10T15:11:12.496Z","avatar_url":"https://github.com/Scribblerockerz.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/1336156/31407710-267e2124-ae06-11e7-8a48-4e7dc3547422.png\" /\u003e\n\u003cbr\u003e\n\u003c/p\u003e\n\n## Introduction\n\nSending plaintext passwords unencrypted through the internet highway isn't just risky, it's ridiculous.\nThis project aims to make this process a bit more secure.\n\nUsually an email inbox of a regular user contains more plaintext passwords than emails from rich african princes.\n\nRetain control over the data which is send out, and prevent living-security-issues laying around in the users inbox.\n\n## Demo\n\n![Screen capture of the application](https://user-images.githubusercontent.com/1336156/32858885-31374bc8-ca4d-11e7-9b1a-b4a67769a241.gif)\n\n## Features\n\n- **Self-hosted**  \n  Grab it. Use it.\n\n- **Client side AES-256 encryption**  \n  Messages are encrypted on the client side with the amazing [crypto-js](https://www.npmjs.com/package/crypto-js) library.\n\n  The key is appended as a hash, so it never hits the server. (*In case of a hack on the micro-service, only encrypted garbage is captured*.)\n\n- **Messages with a TTL**  \n  Decide how long this message can survive after the client opens it.\n\n- **Restricted message access**  \n  Messages are restricted to the client's IP address at the first opening. Messages posted through facebook or other link checking tools prevent opening of the message.\n\n---\n## Quick usage\n\nCreate a `docker-compose.yml` with the following contents and run `docker-compose up`.\n\n```yaml\n# docker-compose.yml\nversion: '3'\n\nservices:\n    redis:\n        image: 'redis:alpine'\n        ports:\n            - '6379:6379'\n    app:\n        image: 'scribblerockerz/cryptletter:latest'\n        ports:\n            - '8080:8080'\n        links:\n            - redis\n        environment:\n            - 'REDIS__ADDRESS=redis:6379'\n            - 'APP__LOG_LEVEL=4'\n```\n\n## Requirements\nThis microservice requires redis to work and can be run via docker or standalone executable.\n\n## Configuration\n\nConfiguration can be provided via configuration yaml or env variables.\n\nYou can run `cryptletter config:init` to generate a fresh `cryptletter.yml` in your working directory.\nYou can also specify the config file by providing it as an argument to the executable:\n\n```bash\n$ cryptletter --config ../your/own/path/you-name-it.yml\n```\n\n\n```yml\n# cryptletter.yml\napp:\n  # How long should the message survive, without getting opened? (minutes)\n  default_message_ttl: 43830\n  # LOUDER \u003e quieter\n  log_level: 4\n  # Current env, use \"dev\" to disable cors for local development\n  env: prod\n  \n  # Serving config\n  server:\n    port: 8080\n\n  # Restrict creation of new letters with a password (good enough to lockout the public)\n  creation_protection_password: \"\"\n    \n  # Inject custom css and custom js configuration\n  additional:\n    css: './web/example/additional.css'\n    js: './web/example/custom.js'\n    \n  attachments:\n    # Files must be removed if the message reached it's TTL and is no longer reachable \n    cleanup_schedule: * * * * *\n    # Supported driver: s3, local or \"\" to disable attachment support\n    driver: local\n    # Directory for uploaded attachments\n    storage_path: cryptletter-uploads\n\n# Redis config\nredis:\n  address: 127.0.0.1:6379\n  database: 0\n  password: \"\"\n\n# S3 configuration for attachment.driver: s3\ns3:\n  access_id: minioadmin\n  access_secret: minioadmin\n  bucket_name: cryptletter-attachments\n  bucket_region: eu-central-1\n  endpoint: http://127.0.0.1:9000\n  secure: true\n\n```\n\nEnvironment variables can be used with `__` as the replacement for dot notation.\n\n```\n$ APP__LOG_LEVEL=0 cryptletter\n```\n\n\n## Customization\n\nThis microservice is designed to work as it is. It comes with an embedded version of the frontend app (thanks to [go:embed](https://golang.org/pkg/embed/)).\n\nIt's possible to insert some css to adjust the appearance of the app, and override/translate the wording via a js configuration.\n```yml\n# cryptletter.yml\napp:\n  additional:\n    css: './your/own/additional.css'\n    js: './your/own/custom.js'\n```\n\nFurther customization require a full build, since the assets are embedded into the executable for ease of use.\n\n## Build\n\nRun `./build.sh` and get your executable (you may adjust the docker build push destination).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscribblerockerz%2Fcryptletter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscribblerockerz%2Fcryptletter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscribblerockerz%2Fcryptletter/lists"}