{"id":20564039,"url":"https://github.com/comake/solid-redis","last_synced_at":"2026-03-09T10:01:28.720Z","repository":{"id":57681788,"uuid":"477984547","full_name":"comake/solid-redis","owner":"comake","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-03T15:48:53.000Z","size":1348,"stargazers_count":5,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-26T19:46:35.449Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/comake.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-04-05T05:15:51.000Z","updated_at":"2023-01-17T12:45:41.000Z","dependencies_parsed_at":"2024-11-16T05:00:35.962Z","dependency_job_id":null,"html_url":"https://github.com/comake/solid-redis","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"958ba87e9c0b7895276e4a8b5f03edbc906daba1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/comake/solid-redis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comake%2Fsolid-redis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comake%2Fsolid-redis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comake%2Fsolid-redis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comake%2Fsolid-redis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/comake","download_url":"https://codeload.github.com/comake/solid-redis/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comake%2Fsolid-redis/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30290898,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-16T04:23:33.554Z","updated_at":"2026-03-09T10:01:28.703Z","avatar_url":"https://github.com/comake.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Redis database backend extension for the Community Solid Server\n\nStore data in your Solid Pod with a [Redis Database](https://redis.io/). Redis is an open source, in-memory data store.\n\n*Disclaimer: By default Redis saves snapshots of the dataset on disk, in a binary file called `dump.rdb`. This library does not alter these default persistence settings and does not include any extra calls to save the database to disk. [Read more about persistence in redis.](https://redis.io/docs/manual/persistence/)*\n\n#### Implementation details\nFor data with content type `internal/quads`, Solid Redis transforms quads into strings by concatenating their subject, predicate, and object values with the | (pipe) character. These strings are stored in [Redis Sets](https://redis.io/docs/manual/data-types/#sets). These Sets serve as the storage of the triples in LDP resources and their keys are the URIs of each resource. Solid Redis uses some special keys to store the metadata, children, and content type of resources.\n\nBecause Redis [does not support empty Sets](https://github.com/redis/redis/issues/6048), for resources or metadata which should exist but contain no triples, Solid Redis stores a Set with a single dummy value of \"1\". These dummy values do not get exposed outside of the `RedisDataAccessor` class.\n\nAll other content types other than `internal/quads` are stored as strings. Redis can store any arbitrary binary data as a string up to 512Mb.\n\n## How to use Solid Redis\n\n### Install\nFrom the npm package registry:\n```shell\nmkdir my-server\ncd my-server\nnpm install @solid/community-server@v4.0.0 @comake/solid-redis\n```\n\n### Install Redis\nFollow [Getting started with Redis](https://redis.io/docs/getting-started/) to install and run Redis.\n\n### Configure\n\nThis extension can be used in 3 ways:\n1. As your CSS's backend to store pod data.\n2. As your CSS's key-value storage to store internal data (accounts, locks, tokens, etc.).\n3. As both!\n\n#### 1. As a backend\nIn your server's root folder (`my-server` or whatever the name of your project is) create a `config.json` file from [this template (config-backend-example.json)](https://github.com/comake/solid-redis/blob/main/config-backend-example.json), and fill out your settings. The only important changes to make to the [default config](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/config/default.json) are to add `solid-redis` into `@context` and to change the backend storage to redis:\n```diff\n-\"files-scs:config/storage/backend/*.json\",\n+\"files-csr:config/storage/backend/redis.json\",\n```\n\n#### 2. As a key-value store\nIn your server's root folder create a `config.json` file from [this template (config-key-value-store-example.json)](https://github.com/comake/solid-redis/blob/main/config-key-value-store-example.json), and fill out your settings. The only important changes to make to the [default config](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/config/default.json) are to add `solid-redis` into `@context` and change the key-value storage to redis:\n```diff\n-\"files-scs:config/storage/key-value/*.json\",\n+\"files-csr:config/storage/key-value/redis.json\",\n```\n\n\n#### 3. As both\nIn your server's root folder create a `config.json` file from [this template (config-all-storage-example.json)](https://github.com/comake/solid-redis/blob/main/config-all-storage-example.json), and fill out your settings. The only important changes to make to the [default config](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/config/default.json) are to add `solid-redis` into `@context` and change the backend and key-value storage to the global redis storage:\n\n```diff\n-\"files-scs:config/storage/backend/*.json\",\n-\"files-scs:config/storage/key-value/*.json\"\n+\"files-csr:config/storage/backend/redis.json\",\n+\"files-scs:config/storage/key-value/resource-store.json\",\n```\n\n### Configure the redis connection\nOptionally, you can change the connection settings for your Redis database by adding parameters to the `RedisDataAccessor` in the `@graph` section of the `config.json` file you just created such as:\n```json\n{\n  \"@id\": \"urn:solid-redis:default:RedisDataAccessor\",\n  \"comment\": \"The configuration to connect to the Redis instance.\",\n  \"RedisDataAccessor:_configuration_host\": \"52.22.22.22\",\n  \"RedisDataAccessor:_configuration_port\": \"1234\",\n}\n```\nIf you do not include this section, `host` defaults to `localhost` and `port` defaults to `6379`, which are the Redis defaults.\n\nYou may optionally also include a `username` and `password` if your database requires them and a `dbNumber` if you don't use the default 0 database.\n\n### Run CSS\nExecute the following command:\n```shell\nnpx community-solid-server -c config.json -m .\n```\nOr add the command to `scripts` inside your package.json like so:\n```json\n{\n  \"scripts\": {\n    \"start\": \"npx community-solid-server -c config.json -m .\"\n  }\n}\n```\n\n## How to contribute to Solid Redis\n\nExecute the following commands:\n```shell\ngit clone https://github.com/comake/solid-redis.git\ncd solid-redis\nnpm ci\n```\n\n## TODO\n- [ ] Add support for different Redis modules such as:\n  - [RedisJSON](https://github.com/RedisJSON/RedisJSON) so the json data can be updated \u0026 queried as JSON instead of strings\n  - [RediSearch](https://github.com/RediSearch/RediSearch) to do full text search over the data in redis\n- [ ] Remove the Redis client mock in integration tests and have them run on CI in docker with a real redis instance\n\n## License\n\n©2022-present Comake, Inc., [MIT License](https://github.com/comake/solid-redis/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomake%2Fsolid-redis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomake%2Fsolid-redis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomake%2Fsolid-redis/lists"}