diff --git a/README.md b/README.md index ba771a7..105604d 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Using Anonymous Github ## How to create a new anonymized repository To use it, open the main page (e.g., [http://anonymous.4open.science/](http://anonymous.4open.science/)), login with GitHub, and click on "Anonymize". -Simply fill 1. the Github repo URL and 2. the id of the anonymized repository, 3. the terms to anonymize (which can be updated afterwards). +Simply fill 1. the Github repo URL and 2. the id of the anonymized repository, 3. the terms to anonymize (which can be updated afterward). The anonymization of the content is done by replacing all occurrences of words in a list by "XXX". The word list is provided by the authors, and typically contains the institution name, author names, logins, etc... The README is anonymized as well as all files of the repository. Even filenames are anonymized. @@ -40,11 +40,11 @@ To start using Anonymous Github right now, a public instance of anonymous_github ## What is the scope of anonymization? -In double-blind 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 deliberate attempt to break anonymity ([explanation](http://www.monperrus.net/martin/open-science-double-blind)) +In double-blind 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](http://www.monperrus.net/martin/open-science-double-blind)) -How it works? --------------- +How does it work? +----------------- Anonymous Github either download the complete repository and anonymize the content of the file or proxy the request to GitHub. In both case, the original and anonymized versions of the file are cached on the server. @@ -57,7 +57,7 @@ cd anonymous_github npm i ``` -2. Configure the Github tocken +2. Configure the Github token Create a file `.env` that contains @@ -71,7 +71,7 @@ DB_PASSWORD= AUTH_CALLBACK=http://localhost:5000/github/auth, ``` -`GITHUB_TOKEN` can be generate here: https://github.com/settings/tokens/new with `repo` scope. +`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:///github/auth` (the same as defined in AUTH_CALLBACK). @@ -82,7 +82,7 @@ docker-compose up -d 4. Go to Anonymous Github -By default, Anonymous Github uses the port 5000. It can be changed in `docker-compose.yml`. +By default, Anonymous Github uses port 5000. It can be changed in `docker-compose.yml`. Related tools diff --git a/index.js b/index.js index 34b00a9..8384e32 100644 --- a/index.js +++ b/index.js @@ -44,7 +44,7 @@ app.use("/github", rateLimit, connection.router); // app routes app.use("/api/user", rateLimit, require("./routes/user")); app.use("/api/repo", rateLimit, require("./routes/file")); -app.use("/api/repo", rateLimit, require("./routes/repositoy")); +app.use("/api/repo", rateLimit, require("./routes/repository")); // wesite view app.use("/w/", rateLimit, require("./routes/webview")); diff --git a/public/i18n/locale-en.json b/public/i18n/locale-en.json index a12d0db..63d1a42 100644 --- a/public/i18n/locale-en.json +++ b/public/i18n/locale-en.json @@ -1,7 +1,7 @@ { "ERRORS": { "repo_not_found": "The repository is not found.", - "repo_not_accessible": "Anonymous GitHub does not have the persmission to access the repository.", + "repo_not_accessible": "Anonymous GitHub does not have the permission to access the repository.", "repository_expired": "The repository is expired", "repository_not_ready": "Anonymous GitHub is still processing the repository, it can take several minutes.", "repo_is_updating": "Anonymous GitHub is still processing the repository, it can take several minutes.", @@ -9,9 +9,9 @@ "repoId_already_used": "The repository id is already used.", "invalid_repoId": "The format of the repository id is invalid.", "branch_not_specified": "The branch is not specified.", - "options_not_provided": "Anonimization options are mendatory.", + "options_not_provided": "Anonymization options are mandatory.", "invalid_terms_format": "Terms are in an invalid format.", - "unable_to_anonymize": "An error happened during the anonimization proccess. Please try later or report the issue.", + "unable_to_anonymize": "An error happened during the anonymization process. Please try later or report the issue.", "non_supported_mode": "The selected anonymization mode is invalid, only download and stream are supported.", "invalid_path": "The provided path is invalid or missing.", "file_not_found": "The requested file is not found.", @@ -24,8 +24,8 @@ "branches_not_found": "The requested branch is not found.", "readme_not_available": "No readme for the repository is found.", "user_not_found": "The current user is not found in the database", - "not_connected": "User is not connectd", - "page_not_supported_on_different_branch": "Anonimized GitHub pages are only supported on the same branch.", - "page_not_activated": "Anonimized GitHub page is not enabled." + "not_connected": "User is not connected", + "page_not_supported_on_different_branch": "Anonymized GitHub pages are only supported on the same branch.", + "page_not_activated": "Anonymized GitHub page is not enabled." } } diff --git a/public/partials/anonymize.htm b/public/partials/anonymize.htm index 9dc05e5..da5110d 100644 --- a/public/partials/anonymize.htm +++ b/public/partials/anonymize.htm @@ -16,9 +16,9 @@ name="anonymize" novalidate > -
Annoymize a reposiotry
+
Anonymize a repository
- Fill the information to annoymize! It will only take 5min. + Fill the information to anonymize! It will only take 5min.
@@ -50,7 +50,7 @@ class="invalid-feedback" ng-show="anonymize.repoUrl.$error.used" > - {{repoUrl}} is already anonymized + {{repoUrl}} is already d
@@ -316,7 +316,7 @@ >Github page Enable anonymized Github pages. It currently only suported for Github pages that are defined in the same branch. It will be available + >Enable anonymized Github pages. It currently only supported for Github pages that are defined in the same branch. It will be available at https://anonymous.4open.science/w/{{repoId}} @@ -333,7 +333,7 @@ > Display the number of line of code in the - reposiotry @@ -490,7 +490,7 @@ ng-show="repoUrl" ng-if="!isUpdate" > - Annoymize + Anonymize