Skip to content

Commit

Permalink
Remove non-essentials from config file
Browse files Browse the repository at this point in the history
Instead, users are pointed to the website where all configuration
options are listed.
  • Loading branch information
IQAndreas committed Jun 1, 2014
1 parent 016e8f7 commit 9fed7f6
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 28 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Fork of one of the tools by [Max Korenkov](https://github.com/mkorenkov) separat

#### Usage ####

The script will by default look for a file named `config.ini` located in the same folder as the Python script. For a list of all possible configuration options, see [Configuration](http://www.iqandreas.com/github-issues-import/configuration/).
The script will by default look for a file named `config.ini` located in the same folder as the Python script. For a list of all possible configuration options, see [_Configuration_](http://www.iqandreas.com/github-issues-import/configuration/).

To quickly get started, rename `config.ini.sample` to `config.ini`, and edit the fields to match your login info and repository info. If you want to use a different credentials for the source and target repositories, please see [Configuration: Enterprise Accounts and Advanced Login Options](http://www.iqandreas.com/github-issues-import/configuration/#enterprise). Store the config file in the same folder as the `gh-issues-import.py` script, or store it in a different folder, using the `--config <file>` option to specify which config file to load in.
To quickly get started, rename `config.ini.sample` to `config.ini`, and edit the fields to match your login info and repository info. If you want to use a different credentials for the source and target repositories, please see [_Configuration: Enterprise Accounts and Advanced Login Options_](http://www.iqandreas.com/github-issues-import/configuration/#enterprise). Store the config file in the same folder as the `gh-issues-import.py` script, or store it in a different folder, using the `--config <file>` option to specify which config file to load in.

**Warning:** The password is stored in plain-text, so avoid storing the config file in a public repository. To avoid this, you can instead pass the username and/or password as arguments by using the `-u <username>` and `-p <password>` flags respectively. If the username or password is not passed in from either of these locations, the user will be prompted for them when the script runs.

Expand Down Expand Up @@ -43,7 +43,7 @@ If allowed by GitHub's policies, it may be a good idea to use a "neutral" accoun

#### Templates ####

The script will by default use the [Markdown-formatted](http://github.github.com/github-flavored-markdown/) templates found in the [`templates`](templates/) directory. You can edit those, or point to your own templates from the config file.
The script will by default use the [Markdown-formatted](http://github.github.com/github-flavored-markdown/) templates found in the [`templates`]({{site.github_url}}/tree/master/templates/) directory. You can edit those, or point to your own templates from the config file; see [_Custom Templates_](http://www.iqandreas.com/github-issues-import/templates/) for more details.

#### Examples ####

Expand Down
22 changes: 8 additions & 14 deletions config-enterprise.ini.sample
Original file line number Diff line number Diff line change
@@ -1,26 +1,20 @@
# Rename to `config.ini`, and keep it in the same folder as `gh-issues-import.py`
# All optional fields have been commented out.
# For a full list of options, see <http://www.iqandreas.com/github-issues-import/configuration/>

[source]
server = github.com
repository = octocat/Hello-World
username = user@example.com
password = naked_password
repository = OctoCat/Hello-World
username = octocat@github.com
password = plaintext_pa$$w0rd

[target]
server = helloworld.org
repository = helloworld-inc/Hello-World
username = other_user@helloworld.org
password = naked_password
server = octodog.org
repository = OctoDog/Hello-World
username = admin@octodog.org
password = plaintext_pass\/\/ord

[format] # These can be adjusted based on your group's region and language.

# Unless an absolute path is given, the templates are relative to the current working directory.
# Example (and default) templates can be found in the `templates` folder.
#issue_template = templates/issue.md
#pull_request_template = templates/pull_request.md
#comment_template = templates/comment.md

# If unsure, just using '%c' will default to the locale’s appropriate date and time representation.
#date = %A %b %d, %Y at %H:%M GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT

16 changes: 5 additions & 11 deletions config.ini.sample
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
# Rename to `config.ini`, and keep it in the same folder as `gh-issues-import.py`
# All optional fields have been commented out.
# For a full list of options, see <http://www.iqandreas.com/github-issues-import/configuration/>

[login]
username = [email protected]
password = naked_password
username = OctoDog
password = plaintext_pa$$w0rd

[source]
repository = octocat/Hello-World
repository = OctoCat/Hello-World

[target]
repository = helloworld-inc/Hello-World
repository = OctoDog/Hello-World

[format] # These can be adjusted based on your group's region and language.

# Unless an absolute path is given, the templates are relative to the current working directory.
# Example (and default) templates can be found in the `templates` folder.
#issue_template = templates/issue.md
#pull_request_template = templates/pull_request.md
#comment_template = templates/comment.md

# If unsure, just using '%c' will default to the locale’s appropriate date and time representation.
#date = %A %b %d, %Y at %H:%M GMT # Sample: Friday Sep 13, 2013 at 22:58 GMT

0 comments on commit 9fed7f6

Please sign in to comment.