{"id":17641355,"url":"https://github.com/dotzero/pad","last_synced_at":"2025-05-06T21:26:54.916Z","repository":{"id":57602389,"uuid":"100884339","full_name":"dotzero/pad","owner":"dotzero","description":"🗒️ Pad is a standalone version of Cloud Notepad. Allows you to share any text data via unique links","archived":false,"fork":false,"pushed_at":"2022-04-28T13:11:37.000Z","size":6304,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T03:08:01.526Z","etag":null,"topics":["cloud","docker","go","golang","notepad","sharing","standalone"],"latest_commit_sha":null,"homepage":"https://pad.dotzero.dev","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/dotzero.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}},"created_at":"2017-08-20T19:37:15.000Z","updated_at":"2024-11-20T06:35:51.000Z","dependencies_parsed_at":"2022-09-26T16:40:34.041Z","dependency_job_id":null,"html_url":"https://github.com/dotzero/pad","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/dotzero%2Fpad","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotzero%2Fpad/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotzero%2Fpad/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotzero%2Fpad/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotzero","download_url":"https://codeload.github.com/dotzero/pad/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252771097,"owners_count":21801649,"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":["cloud","docker","go","golang","notepad","sharing","standalone"],"created_at":"2024-10-23T07:05:21.057Z","updated_at":"2025-05-06T21:26:54.891Z","avatar_url":"https://github.com/dotzero.png","language":"Go","readme":"# Pad\n\n[![build](https://github.com/dotzero/pad/actions/workflows/ci-build.yml/badge.svg)](https://github.com/dotzero/pad/actions/workflows/ci-build.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/dotzero/pad)](https://goreportcard.com/report/github.com/dotzero/pad)\n[![Docker Automated build](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg)](https://hub.docker.com/r/dotzero/pad/)\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dotzero/pad/blob/master/LICENSE)\n\nPad is a standalone version of Cloud Notepad. Allows you to share any text data via unique links.\n\nData stored in [boltdb](https://github.com/etcd-io/bbolt) (embedded key/value database) files under `BOLT_PATH`.\n\n![](https://raw.githubusercontent.com/dotzero/pad/master/static/images/screenshot.png)\n\n## Running container in Docker\n\n```bash\ndocker run -d --rm --name pad -p \"8080:8080\" dotzero/pad\n```\n\n### Running container with Docker Compose\n\nCreate a `docker-compose.yml` file:\n\n```yaml\nversion: \"3\"\nservices:\n  pad:\n    image: ghcr.io/dotzero/pad:latest\n    container_name: pad\n    restart: always\n    logging:\n      driver: json-file\n      options:\n        max-size: \"10m\"\n        max-file: \"5\"\n    ports:\n      - \"8080:8080\"\n    environment:\n      PAD_HOST: \"0.0.0.0\"\n      PAD_PORT: \"8080\"\n      PAD_SECRET: random_salt_here\n    volumes:\n      - pad_db:/app/db\n\nvolumes:\n  pad_db:\n```\n\nRun `docker-compose up -d`, wait for it to initialize completely, and visit `http://localhost:8080`\n\n### Build container\n\n```bash\ndocker build -t dotzero/pad .\n```\n\n## How to run it locally\n\n```bash\ngit clone https://github.com/dotzero/pad\ncd pad\ngo run .\n```\n\n### Command line options\n\n```bash\nUsage:\n  pad [OPTIONS]\n\nApplication Options:\n      --host=        listening address (default: 0.0.0.0) [$PAD_HOST]\n      --port=        listening port (default: 8080) [$PAD_PORT]\n      --bolt-path=   parent directory for the bolt files (default: ./var) [$BOLT_PATH]\n      --secret=      the shared secret key used to generate ids [$PAD_SECRET]\n      --static-path= path to website assets (default: ./static) [$STATIC_PATH]\n      --tpl-path=    path to templates files (default: ./templates) [$TPL_PATH]\n      --tpl-ext=     templates files extensions (default: .html) [$TPL_EXT]\n      --verbose      verbose logging\n  -v, --version      show the version number\n\nHelp Options:\n  -h, --help         Show this help message\n```\n\n### Environment variables\n\n* `PAD_HOST` (*default:* `0.0.0.0`) - listening address\n* `PAD_PORT` (*default:* `8080`) - listening port\n* `BOLT_PATH` (*default:* `./var`) - path to BoltDB database (it represents a consistent snapshot of your data)\n* `PAD_SECRET` (*default:* `empty`) - salt that using to generate hashids. **Strongly** recommend to replace with your own value\n* `STATIC_PATH` (*default:* `./static`) - path to web assets\n* `TPL_PATH` (*default:* `./templates`) - path to templates\n* `TPL_EXT` (*default:* `.html`) - templates files extensions\n\n## License\n\nhttp://www.opensource.org/licenses/mit-license.php\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotzero%2Fpad","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotzero%2Fpad","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotzero%2Fpad/lists"}