diff --git a/public/partials/faq.htm b/public/partials/faq.htm index f9f86fc..f73df01 100644 --- a/public/partials/faq.htm +++ b/public/partials/faq.htm @@ -6,98 +6,132 @@ aria-label="FAQs" >
+ Everything you need to know about using Anonymous GitHub for double-anonymous peer review. +
+ + +-
+ Anonymous GitHub either downloads the complete repository and anonymizes the content, or proxies + requests to GitHub on the fly. In both cases, the original and anonymized versions of files are + cached on the server. The system automatically detects and replaces the repository owner, + organization name, and repository name. You can also specify additional custom terms to anonymize + using one-per-line regex patterns. +
+- Anonymous Github is able to display pure textual files, such as text or source code. It can also render images, PDFs, and notbooks. - However, only textual based files are anonymized. Anonymous Github analyzes the content of the file to detect if it is textual or not. + In double-anonymous peer review, the boundary of anonymization is the paper plus its online + appendix — not the entire internet. Searching for any part of the paper or the online appendix + can be considered a deliberate attempt to break anonymity. Anonymous GitHub anonymizes the + repository owner, organization, repository name, file and directory names, and file contents + across all text-based file types.
+ Anonymous GitHub is completely free to use. However, the server costs hundreds of dollars per year + to maintain. If you find the service useful, a small donation would be greatly appreciated. You can + support the project by + sponsoring on GitHub, + donating through Ko-fi, or by clicking + the "Support me" button on the site. +
++ Anonymous GitHub can display and render a wide variety of file types: +
++ Only text-based files are anonymized. Anonymous GitHub analyzes the content of each file to + determine whether it is textual or binary. +
++ Yes. In addition to full repositories, Anonymous GitHub supports anonymizing individual pull + requests. Simply paste the URL of a GitHub pull request when creating a new anonymized repository, + and the system will automatically detect that it is a pull request and anonymize it accordingly. +
++ When creating an anonymized repository, you can associate it with a Conference ID. This allows + conferences to define default anonymization settings (such as expiration dates) that are + automatically applied to repositories submitted under that conference. If your conference + provides a Conference ID, enter it during the anonymization setup. +
++ You can configure one of three expiration strategies when creating your anonymized repository: +
+- Anonymous Github is free to use, however the server costs me hundreds of dollars per year, a small donation to cover the cost of the server would be largely appreciated. - You can support me financially by Sponsoring my GitHub account, send me money thought Ko-fi or by clicking on the "Support me" button. + Yes. Anonymized repositories can be downloaded as a ZIP file. This is useful if reviewers + want to build or test the code locally. The downloaded archive contains the fully anonymized + version of the repository.
+ Yes. Anonymous GitHub provides a CLI tool that lets you anonymize repositories locally, + generating an anonymized ZIP file on your machine. Install it via npm: +
+npm install -g @tdurieux/anonymous_github
+anonymous_github
+ - The data stored on Anonymous Github are never used or shared in any cases. - When a repository is removed or expired only the configuration of the repository is conserved to be able to restore easily the repository and to ensure that no future repository will use the same repository id. + Data stored on Anonymous GitHub is never shared or used for any purpose beyond providing the + anonymization service. When a repository is removed or expires, only its configuration is + retained — this makes it easy to restore the repository if needed and ensures that no + future repository reuses the same ID.
- The viewers of the repository are not tracked, only the number of view of the repository is collected (a incremental digit). - It is not possible for the repository owner neither for Anonymous GitHub to track down the identity of the viewer. + No. Only the total number of views is tracked as an incremental counter. It is not possible + for the repository owner or for Anonymous GitHub to identify individual viewers. + Reviewer anonymity is fully preserved.
- Anonymous GitHub is fully open source and the deployment of a new instance is relatively easy. More information can be found on the GitHub repository of the project. + Yes. Anonymous GitHub is fully open source (GPL-3.0) and supports Docker-based deployment. + You will need to configure a GitHub OAuth app and provide a GitHub token. Detailed setup + instructions are available on the + GitHub repository. +
++ The basic steps are:
+.env file with your GitHub token, OAuth client ID, and client secretdocker-compose up -d+ Still have questions? +
++ Open an issue on the + GitHub repository + and we'll be happy to help. +
+