From b0d824a12d5adc17fabb7bb564a162deb5b251da Mon Sep 17 00:00:00 2001 From: Nils Deppe Date: Thu, 20 Jul 2017 09:54:46 -0400 Subject: [PATCH] Add documentation for using with two-factor authentication --- README | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README b/README index d463fa3..40b51c6 100644 --- a/README +++ b/README @@ -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. \ No newline at end of file +- Strips some characters from ticket bodys / comments like ü/ä/ö etc.