mirror of
https://github.com/tdurieux/anonymous_github.git
synced 2026-07-29 08:19:02 +02:00
docs: polish README (clearer intro, badges, structure)
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
tdurieux
co-authored by
Claude Opus 4.8
Claude Opus 4.8
parent
f040557ae8
commit
2af4637cc7
@@ -1,87 +1,104 @@
|
|||||||
# Anonymous Github
|
<div align="center">
|
||||||
|
|
||||||
Anonymous Github is a system that helps anonymize Github repositories for double-anonymous paper submissions. A public instance of Anonymous Github is hosted at https://anonymous.4open.science/.
|
# Anonymous GitHub
|
||||||
|
|
||||||
|
**Share your code and data for double-anonymous peer review — without giving your identity away.**
|
||||||
|
|
||||||
|
[](https://www.npmjs.com/package/@tdurieux/anonymous_github)
|
||||||
Anonymous Github anonymizes the following:
|
[](LICENSE)
|
||||||
|
[](https://anonymous.4open.science/)
|
||||||
- Github repository owner, organization, and name
|
[](https://github.com/tdurieux/anonymous_github/stargazers)
|
||||||
- File and directory names
|
|
||||||
- File contents of all extensions, including markdown, text, Java, etc.
|
[**Public instance**](https://anonymous.4open.science/) · [How it works](#how-it-works) · [Self-hosting](#self-hosting)
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
### Public instance
|
</div>
|
||||||
|
|
||||||
**https://anonymous.4open.science/**
|
## Why
|
||||||
|
|
||||||
### CLI
|
Double-anonymous review asks you to anonymize the artifact behind your paper — the code and data — exactly like the paper itself. Doing that by hand (owner, organization, repository name, logins, and every mention buried in the files) is tedious and easy to get wrong. Anonymous GitHub does it for you and serves the result behind a shareable link.
|
||||||
|
|
||||||
This CLI tool allows you to anonymize your GitHub repositories locally, generating an anonymized zip file based on your configuration settings.
|
A free public instance is available at **[anonymous.4open.science](https://anonymous.4open.science/)**.
|
||||||
|
|
||||||
```bash
|
## What it anonymizes
|
||||||
# Install the Anonymous GitHub CLI tool
|
|
||||||
npm install -g @tdurieux/anonymous_github
|
- The GitHub **owner, organization, and repository name**
|
||||||
|
- **File and directory names**
|
||||||
# Run the Anonymous GitHub CLI tool
|
- **File contents** of every extension (Markdown, text, source code, …), replacing a configurable list of terms
|
||||||
anonymous_github
|
|
||||||
```
|
## Usage
|
||||||
|
|
||||||
### Own instance
|
### Public instance
|
||||||
|
|
||||||
#### 1. Clone the repository
|
Just open **[anonymous.4open.science](https://anonymous.4open.science/)**, paste your repository URL, add the terms to hide, and share the generated link.
|
||||||
|
|
||||||
```bash
|
### CLI
|
||||||
git clone https://github.com/tdurieux/anonymous_github/
|
|
||||||
cd anonymous_github
|
Anonymize a repository locally and produce an anonymized zip:
|
||||||
npm i
|
|
||||||
```
|
```bash
|
||||||
|
npm install -g @tdurieux/anonymous_github
|
||||||
#### 2. Configure the GitHub token
|
anonymous_github
|
||||||
|
```
|
||||||
Create a `.env` file with the following contents:
|
|
||||||
|
## Self-hosting
|
||||||
```env
|
|
||||||
GITHUB_TOKEN=<GITHUB_TOKEN>
|
<details>
|
||||||
CLIENT_ID=<CLIENT_ID>
|
<summary>Run your own instance with Docker</summary>
|
||||||
CLIENT_SECRET=<CLIENT_SECRET>
|
|
||||||
PORT=5000
|
**1. Clone and install**
|
||||||
DB_USERNAME=
|
|
||||||
DB_PASSWORD=
|
```bash
|
||||||
AUTH_CALLBACK=http://localhost:5000/github/auth,
|
git clone https://github.com/tdurieux/anonymous_github/
|
||||||
```
|
cd anonymous_github
|
||||||
|
npm i
|
||||||
- `GITHUB_TOKEN` can be generated here: https://github.com/settings/tokens/new with `repo` scope.
|
```
|
||||||
- `CLIENT_ID` and `CLIENT_SECRET` are the tokens are generated when you create a new GitHub app https://github.com/settings/applications/new.
|
|
||||||
- The callback of the GitHub app needs to be defined as `https://<host>/github/auth` (the same as defined in AUTH_CALLBACK).
|
**2. Configure GitHub access** — create a `.env` file:
|
||||||
|
|
||||||
#### 3. Start Anonymous Github server
|
```env
|
||||||
|
GITHUB_TOKEN=<GITHUB_TOKEN>
|
||||||
```bash
|
CLIENT_ID=<CLIENT_ID>
|
||||||
docker-compose up -d
|
CLIENT_SECRET=<CLIENT_SECRET>
|
||||||
```
|
PORT=5000
|
||||||
|
DB_USERNAME=
|
||||||
#### 4. Go to Anonymous Github
|
DB_PASSWORD=
|
||||||
|
AUTH_CALLBACK=http://localhost:5000/github/auth
|
||||||
Go to http://localhost:5000. By default, Anonymous Github uses port 5000. It can be changed in `docker-compose.yml`. I would recommand to put Anonymous GitHub behind ngnix to handle the https certificates.
|
```
|
||||||
|
|
||||||
## What is the scope of anonymization?
|
- `GITHUB_TOKEN` — create one at <https://github.com/settings/tokens/new> with the `repo` scope.
|
||||||
|
- `CLIENT_ID` / `CLIENT_SECRET` — from a new GitHub App at <https://github.com/settings/applications/new>.
|
||||||
In double-anonymous peer-review, the boundary of anonymization is the paper plus its online appendix, and only this, it's not the whole world. Googling any part of the paper or the online appendix can be considered as a deliberate attempt to break anonymity ([explanation](https://www.monperrus.net/martin/open-science-double-blind))
|
- The App's callback must be `https://<host>/github/auth` (matching `AUTH_CALLBACK`).
|
||||||
|
|
||||||
## How does it work?
|
**3. Start the server**
|
||||||
|
|
||||||
Anonymous Github either downloads the complete repository and anonymizes the content of the file or proxies the request to GitHub. In both cases, the original and anonymized versions of the file are cached on the server.
|
```bash
|
||||||
|
docker-compose up -d
|
||||||
## Related tools
|
```
|
||||||
|
|
||||||
[gitmask](https://www.gitmask.com/) is a tool to anonymously contribute to a Github repository.
|
**4. Open** <http://localhost:5000>. The port can be changed in `docker-compose.yml`; putting Anonymous GitHub behind nginx is recommended for HTTPS.
|
||||||
|
|
||||||
[blind-reviews](https://github.com/zombie/blind-reviews/) is a browser add-on that enables a person reviewing a GitHub pull request to hide identifying information about the person submitting it.
|
</details>
|
||||||
|
|
||||||
## See also
|
## Scope of anonymization
|
||||||
|
|
||||||
- [Open-science and double-anonymous Peer-Review](https://www.monperrus.net/martin/open-science-double-blind)
|
In double-anonymous review, the boundary of anonymization is **the paper plus its online appendix — and only that**. Googling part of the paper or appendix to reveal authorship is considered a deliberate attempt to break anonymity ([explanation](https://www.monperrus.net/martin/open-science-double-blind)).
|
||||||
- [ACM Policy on Double-Blind Reviewing](https://dl.acm.org/journal/tods/DoubleBlindPolicy)
|
|
||||||
|
## How it works
|
||||||
|
|
||||||
|
Anonymous GitHub either downloads the full repository and anonymizes each file, or proxies requests to GitHub on the fly. In both cases the original and anonymized versions are cached on the server, so even large repositories stay responsive.
|
||||||
|
|
||||||
|
## Related tools
|
||||||
|
|
||||||
|
- [gitmask](https://www.gitmask.com/) — contribute anonymously to a GitHub repository.
|
||||||
|
- [blind-reviews](https://github.com/zombie/blind-reviews/) — browser add-on that hides identifying information when reviewing a pull request.
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
- [Open science and double-anonymous peer review](https://www.monperrus.net/martin/open-science-double-blind)
|
||||||
|
- [ACM policy on double-blind reviewing](https://dl.acm.org/journal/tods/DoubleBlindPolicy)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[GPL-3.0](LICENSE) © [Thomas Durieux](https://durieux.me)
|
||||||
|
|||||||
Reference in New Issue
Block a user