Skip to content

Basic Setup

Guy Hershenbaum edited this page Mar 16, 2015 · 14 revisions

This page walks through setting up a basic mail2bug instance
The focus is on getting you up and running quickly, skipping over advanced features. For full config file reference, see the Config file reference

Prerequisites

  • An exchange mailbox to be used as the end-point for receiving emails
    • Requires Exchange 2010 SP1 or later
    • EWS access must be enabled
    • Credentials for accessing the mailbox
  • A user with permissions to read, create, and update work items in the target TFS project
  • A windows machine to run the service on
    • Needs .NET framework 4.5 or later installed
  • The project binaries - see the project ReadMe.md (on the project home page) for instructions on how to build it

Setting up the new service

  • Create a folder for the Service
  • Copy all the files from <project root>\Tolls\DpapiTool\Bin\<Debug|Release>\* to the service folder
  • Copy all the files from <project root>\Mail2Bug\Bin\<Debug|Release>\* to the service folder (override any existing file if needed)
  • Create a sub-folder called Resources under the service folder - this folder will hold all the configuration files for the mail2bug instances
    • Of course, you can use any other folder name
  • Create a config file for your instance in the Resources folder
    • Follow the pattern Mail2BugConfigMyInstanceName**.xml**
    • This pattern is configurable, but we'll use it for simplicity, since it aligns with the default values in the app.config
    • See more details on creating the config below
  • Create the protected password file under the Resources directory, and use it in your config file as needed
    • To create the protected password file, use DpapiTool.exe
    • Make sure to run it under the same credentials that mail2bug.exe will run with
    • The commandline is DpapiTool.exe write /Data=<password> /Out=password.bin

Common errors

Clone this wiki locally