Skip to content

Add documentation for using with two-factor authentication #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nilsdeppe wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for using with two-factor authentication #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,19 @@ Features:
- Slows down to match the 60 requests per second API limit rate

Usage:
1. Edit the configuration variables in the file above the DO NOT EDIT BELOW comment or use the external configuration file, trac2github.cfg.
2. Run it from shell, e.g.:
1. Edit the file 'trac2github.cfg'. You can also edit the `trac2github.php` above the 'DO NOT EDIT BELOW' comment.
2. Run the php file from the shell, e.g.:
$ php trac2github.php

Requirements:
1. PHP (e.g. on Ubuntu `apt-get install php`)
2. Support for the trac database format, e.g. php-mysql, php-sqlite3, etc.
3. php-curl

Athenticating with GitHub, including with two-factor authentication:
1. Set up a GitHub personal access token, see https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
2. Set the username field in the configuration to your GitHub username
3. Set the password field in the configuration to your GitHub personal access token

Known Problems:
- Strips some characters from ticket bodys / comments like ü/ä/ö etc.
- Strips some characters from ticket bodys / comments like ü/ä/ö etc.