{"id":19178077,"url":"https://github.com/cmdruid/nostr-workbench","last_synced_at":"2026-06-15T18:32:03.169Z","repository":{"id":117493392,"uuid":"591046483","full_name":"cmdruid/nostr-workbench","owner":"cmdruid","description":"A docker workbench environment, pre-configured for running a nostr relay using nostr-rs-relay (rust).","archived":false,"fork":false,"pushed_at":"2023-01-19T20:05:29.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-23T01:25:24.216Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cmdruid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-01-19T20:03:37.000Z","updated_at":"2023-01-19T20:04:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"f2e1c857-54a8-413c-bf69-d92b9d8819b7","html_url":"https://github.com/cmdruid/nostr-workbench","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cmdruid/nostr-workbench","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmdruid%2Fnostr-workbench","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmdruid%2Fnostr-workbench/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmdruid%2Fnostr-workbench/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmdruid%2Fnostr-workbench/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cmdruid","download_url":"https://codeload.github.com/cmdruid/nostr-workbench/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmdruid%2Fnostr-workbench/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34376121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-09T10:36:52.646Z","updated_at":"2026-06-15T18:32:03.152Z","avatar_url":"https://github.com/cmdruid.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nostr Workbench\n\nA docker workbench environment, pre-configured for running a nostr relay using nostr-rs-relay (rust).\n\n## Overview\n\nHere is an overview of the project filesystem:\n\n```sh\n## Project Directory\n/config      # Mounted as read-only at /config.\n             # Useful for collecting our config files in \n             # one place, so we can tweak them between builds.\n\n/home        # Mounted as read-write at /root/home.\n             # Scripts placed in 'bin' are added to your PATH \n             # environment. The .bashrc script is loaded at login.\n\n/image       # Copied to root filesystem '/' at build time.\n             # Create your desired filesystem in here, using the \n             # proper paths. (for ex. binaries in /image/usr/bin/')\n\n.env.sample  # Example of .env file. Used for setting variables that\n             # are passed into the build and runtime environments.\n\ncompose.yml  # Container configuration file. Launch your container in \n             # detached mode by using: 'docker compose up --build -d'\n\nDockerfile   # Main build file for the docker container. Feel free to \n             # configure this file to your liking!\n\nREADME.md    # You are here!\n```\n\n**Tips**  \n\n- The `Dockerfile` specifies what packages are installed by default. Modify the `apt install` line to add more packages to your container.\n- The `home` folder is reloaded upon login, so you can make changes to your environment frequenlty!\n- Use the `home/bin` folder to store your own custom scripts (and call them directly).\n- Use the `.init` and `.profile` scripts to customize your own shell environment.\n- Feel free to `--build` frequently as you make changes to the filesystem.\n\n## How to Use\n```sh\n## Build the image and start in a container.\ndocker compose up --build\n\n## Start the container in detached mode.\ndocker compose up -d\n\n## You can also do all of this in one line.\ndocker compose up --build -d\n\n## Log into a currently running container.\ndocker exec -it \u003ccontainer name\u003e bash\n\n## If you have any issues with starting your container,\n## log into the container's shell, then start the script.\ndocker compose run -it --entrypoint bash \u003ccontainer name\u003e\n\u003c~/home\u003e entrypoint\n```\n\n### Ngrok Integration\n\nSetting `NGROK_ENABLED=1` in your `.env` file will enable Ngrok integration. This will configure your `spark-qr` command to connect using an encrypted Ngrok tunnel. You will have to sign up [here](https://ngrok.com) in order to receive an `NGROK_TOKEN` and use their service.\n\n## Resources\n\nFor more information and resources, please see the links below.\n\n**Nostr-rs-relay**  \nhttps://sr.ht/~gheartsfield/nostr-rs-relay\n\n**Docker Compose Reference**  \nhttps://docs.docker.com/compose/compose-file\n\n**Docker Builder Reference**  \nhttps://docs.docker.com/engine/reference/builder\n\n**Docker Exec Reference**  \nhttps://docs.docker.com/engine/reference/commandline/exec\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcmdruid%2Fnostr-workbench","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcmdruid%2Fnostr-workbench","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcmdruid%2Fnostr-workbench/lists"}