1567293 - Open source proxy server

Status: RESOLVED FIXED

(Firefox :: New Tab Page, enhancement, P1)

Description

[Mathijs Miermans]

See Matt's comment for steps.

Comment 1

[Mathijs Miermans]

Would you like to add some more details to open-sourcing the proxy server?

Comment 2

[Matt Koidin]

(1) We should set the license to MIT (we can do this in Github)

(2) We should add LICENSE and Contributing.md files. A good example we can base off of is here: https://github.com/Pocket/extension-save-to-pocket

(3) We need to draft the README.md — which will be "overview" of what this code is and how it is used

(4) We should create ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md. See here for examples: https://github.com/Pocket/extension-save-to-pocket/tree/master/.github

(5) Does this code include any third party libraries? If yes, we need to detail the licenses and review. See here for how we document: https://github.com/Pocket/extension-save-to-pocket#third-party-tools-licenses

(6) We will need to decide whether to start with a fresh repo or keep the existing commits you've been making as you've developed. Typically, we start with a "clean" repo; but if there is a reason to keep existing commits, we can.

(7) We should complete security review — sounds like that is already in progress, but let me know if you need my support.

(8) I will get this on legal's radar and confirm who we will work with to review.

Comment 3

[Mathijs Miermans]

Todo:

• (3) Tawanda, could you review/rewrite the ReadMe? Let me know if you can get a Github account through Matt, otherwise I'm happy to coordinate through Google Docs. (I DM'ed you a link.)
• (5) Create a fresh repo.
• (7) Resolve low priority security bugs:
  • https://bugzilla.mozilla.org/show_bug.cgi?id=1571715 (Simple fix.)
  • https://bugzilla.mozilla.org/show_bug.cgi?id=1571717 (Outstanding needinfo in the bug)

Comment 4

[Tawanda Kanhema]

Checked the readMe. Would you like me to create a new document for the whole file or are you ok making the minor edits in the original?

Comment 5

[Mathijs Miermans]

• Rename repo to Proxy-Server-Draft
• Enable signed commits
• Verify everything still works, including CircleCI
• Create new repo Proxy-Server and copy code
  • Make sure not commit private keys and have friendly commit messages

Comment 6

[Jessilyn Davis]

Proxy Server is now public and open-source: https://github.com/Pocket/proxy-server \o/

Thanks, Mathijs!