{"id":47837596,"url":"https://github.com/spring-epfl/signal-collaborative-documents","last_synced_at":"2026-04-03T20:34:28.185Z","repository":{"id":335371199,"uuid":"1118756733","full_name":"spring-epfl/signal-collaborative-documents","owner":"spring-epfl","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-04T14:16:38.000Z","size":69827,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-04T21:39:12.695Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/spring-epfl.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-18T08:30:23.000Z","updated_at":"2026-03-04T14:16:44.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/spring-epfl/signal-collaborative-documents","commit_stats":null,"previous_names":["spring-epfl/signal-collaborative-documents"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/spring-epfl/signal-collaborative-documents","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-epfl%2Fsignal-collaborative-documents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-epfl%2Fsignal-collaborative-documents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-epfl%2Fsignal-collaborative-documents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-epfl%2Fsignal-collaborative-documents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spring-epfl","download_url":"https://codeload.github.com/spring-epfl/signal-collaborative-documents/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-epfl%2Fsignal-collaborative-documents/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31375769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T17:53:18.093Z","status":"ssl_error","status_checked_at":"2026-04-03T17:53:17.617Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":"2026-04-03T20:34:28.082Z","updated_at":"2026-04-03T20:34:28.164Z","avatar_url":"https://github.com/spring-epfl.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# End-to-end encrypted collaborative documents, using Automerge and Signal\n\n## Dependencies\n\nYou will need Docker to run the experiments (tested with version 28.1.1). \nTo generate plots from the raw benchmark data, you will need [uv](https://docs.astral.sh/uv/) (tested with version 0.10.7). \n\n## Benchmarking\n\nWe provide bash scripts `experiment-{1,2,3}.sh` for each of our experiments. These scripts should be run in the base repository (on your machine). \n\nInternally, each script builds a docker container, optionally artificially restricts the container's network, runs benchmarks inside the container, and generates plots from the resulting data. \nIf you encounter an error while benchmarking, check `signal-cli.{1,2,3,4}.log` for more information. \n\n### Experiment 1 -- Asynchronous Collaboration\n\nRun `experiment-1.sh`. Check `benchmark_data/s1-signal{slow,fast}` (raw data) and `benchmark_plots/s1-cumulative-both.pdf` (plot) for runtimes in an asynchronous collaboration setting.\n\n### Experiment 2 -- Synchronous Collaboration\n\nRun `experiment-2.sh`. Check `benchmark_data/s{2,3}-signal{slow,fast}` (raw\ndata) and `benchmark_plots/s2-slow-vs-fast-split-violins.pdf`\n(plot) for runtimes in a synchronous collaboration setting.\n\n### Experiment 3 -- Large Edits\n\nRun `experiment-3.sh`. Check\n`benchmark_data/s4-large-edits.csv` (raw data)\nand `benchmark_plots/s4.pdf` (plot) to see runtimes in a setting with large edits. \n\n### Debug info\n\nInternally, each experiment script runs `./netprofile.sh \u003cslow|fast|off\u003e` to restrict the network (\"slow\" or \"fast\" setting, or to use the network to its fully capacity (`off`)), and then invokes a `b*.sh` script to run the benchmark. The result of the benchmark will be printed in the console, and will also be written to `benchmark_data/*.csv`.\n\n## (alternative) Benchmarking manually\n\n### Setup\n\nSet up the docker container with\n\n```bash\ndocker compose up --build -d\n./netprofile.sh [slow|fast|off] # Sets latency and bandwidth in container\ndocker exec -it e2ee-cd /bin/bash  # Open shell in Docker container\n```\n\nStart the signal-cli daemon with\n\n```bash\nsignal-cli --config=./signal-data/signal-multiaccount daemon --http  \n```\n\nIf you want to run the benchmark for only one user, use\n\n```bash\nsignal-cli --config=./signal-data/signal-multiaccount -a=$NUMBER daemon --http \n```\n\nFor usability, you might want to `source .env`, which exports the variables `ACCOUNT_1` and `ACCOUNT_2`.\n\nIf you get a warning `WARN  MultiAccountManager - Ignoring $NUMBER: User is not registered. (NotRegisteredException)`: register the signal number as follows (see [signal-cli Wiki](https://github.com/AsamK/signal-cli/wiki/Linking-other-devices-(Provisioning))):\n\n```bash\nsignal-cli --config=./signal-data/signal-multiaccount link -n \"${OPTIONAL_DEVICE_NAME} | tee \u003e(xargs -L 1 qrencode -t utf8)\n```\n\nThen scan the QR code with a primary device where you are already logged in with the Signal account for `$NUMBER`.\nAlternatively, if your device does not recognize the QR code shown by qrencode, get the link by running `signal-cli --config=./signal-data/signal-multiaccount link -n \"${OPTIONAL_DEVICE_NAME}\"` and paste the `sgnl://linkdevice?uuid=...` link in your favorite QR code generator (e.g., search for \"qr code for $LINK\" on DuckDuckGo).\n\n### Running benchmarks\n\nIn another shell on the same docker container, run one of `b{1,2,4}.sh`. \n\n## Generating the plots\n\nWe use [uv](https://docs.astral.sh/uv/) to manage Python dependencies. To run the Jupyter notebooks, run the following command to automatically read the data in `benchmark_data` and generate plots in `benchmark_plots`.\n\n```bash\nuv run --with jupyter jupyter execute analysis-1.ipynb\nuv run --with jupyter jupyter execute analysis-2-3.ipynb\nuv run --with jupyter jupyter execute analysis_4.ipynb\n```\n\nAlternatively, make sure that you have the correct Python version specified in [.python-version](.python-version), install the dependencies listed in [pyproject.toml](pyproject.toml) along with `jupyter` using your favorite Python package manager, and launch `jupyter`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-epfl%2Fsignal-collaborative-documents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspring-epfl%2Fsignal-collaborative-documents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-epfl%2Fsignal-collaborative-documents/lists"}