{"id":14977739,"url":"https://github.com/redis/redis-clinterwebz","last_synced_at":"2025-08-14T21:05:54.123Z","repository":{"id":37204742,"uuid":"445353700","full_name":"redis/redis-clinterwebz","owner":"redis","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-10T10:30:17.000Z","size":186,"stargazers_count":4,"open_issues_count":10,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-09T09:37:40.419Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redis.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-07T00:47:10.000Z","updated_at":"2024-08-03T07:13:07.000Z","dependencies_parsed_at":"2025-03-16T20:21:34.255Z","dependency_job_id":"8e17ff9c-db9c-4961-9bb7-18985e6e02e0","html_url":"https://github.com/redis/redis-clinterwebz","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/redis/redis-clinterwebz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fredis-clinterwebz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fredis-clinterwebz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fredis-clinterwebz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fredis-clinterwebz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redis","download_url":"https://codeload.github.com/redis/redis-clinterwebz/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redis%2Fredis-clinterwebz/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270482318,"owners_count":24591340,"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","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"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-09-24T13:56:14.637Z","updated_at":"2025-08-14T21:05:54.080Z","avatar_url":"https://github.com/redis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# redis-clinterwebz: a redis-cli in your browser\n\n![screenshot](screenshot.png)\n\nThis project is a browser-based _redis-cli_-like interface.\nIt is mainly intended to serve as the interactive backbone for the https://redis.io website.\nThe project boasts:\n\n* An arcane out-of-the-box TTY experience\n* Multiple named Redis databases (e.g. latest, unstable...)\n* Key namespacing per DB\n* Opt-in per page context (allowing it to be used in the same website across multiple pages)\n* Embeddable JavaScript code\n* ... and much more!\n\n## Getting started\n\nYou can use `docker-compose`:\n\n1. Clone this repository\n1. Change directory to the repository\n1. Do `docker-compose up` to spin up the app, a webserver and an unstable Redis\n\nThe app should be accessible in your browser at http://localhost\n\n### Running the application for development\n\n1. Clone this repository\n1. Change directory to the repository\n1. (Recommended) Use _virtualenv_: `virtualenv -p 3.9 venv; source venv/bin/activate`\n1. Install the app: `pip install -e .`\n1. Copy-paste this to your terminal:\n    ```bash\n    export FLASK_APP=interwebz\n    export FLASK_ENV=development\n    export INTERWEBZ_JSON_SETTINGS=`pwd`/sample_settings.json\n    ```\n1. To run: `flask run`\n\nThe app should be accessible in your browser at http://localhost:5000\n#### Redis Server\n\nTo function correctly, the application requires one or more Redis servers.\n\nThe minimal Redis version required is 7.0.0 (until it is released, please install directly from the source at the __unstable__ branch of the Redis repository).\n\nAn example for a hardend ACL profile is included in the __redis__ directory. To use it:\n\n```bash\ncd redis\nredis-server redis.conf\n```\n\n### Deploying on k8s\n\nWIP\n\n```\n# kubectl port-forward --namespace=ingress-nginx service/ingress-nginx-controller 8080:80\n# https://kubernetes.github.io/ingress-nginx/deploy/#quick-start\nkubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.1.0/deploy/static/provider/cloud/deploy.yaml\nmake up\n```\n\n## Configuration\n\nTo override the defaults (see _default_settings.py_), you can provide your own settings file via the _INTERWEBZ_SETTINGS_ environment variable, like so:\n\n```bash\nEXPORT INTERWEBS_SETTINGS=/path/to/your/settings.py\nflask run\n```\n\nAlternatively, you can also use a JSON file for the same purpose (see _sample_settings.json_) via the _INTERWEBZ_JSON_SETTINGS_ environment variable.\n\n## HTML redis-cli element\n\nTo embed in an HTML page:\n\n1. Import the _cli.js_ script.\n2. Add a `form` element(s) with the `redis-cli` class.\n\n### Attributes\n\nThe _redis-cli_ element supports these attributes:\n\n* _dbid_: the database ID to use, defaults to the first defined database.\n* _asciiart_: controls ASCII art display\n\n## TODO\n\n* Embedded comments inline :)\n* Testing\n* Deployment\n* Request/IP throttling\n* ...","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredis%2Fredis-clinterwebz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredis%2Fredis-clinterwebz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredis%2Fredis-clinterwebz/lists"}