Scope-IT / marksman

Windows agent for Snipe-IT asset management system
Apache License 2.0
129 stars 23 forks source link
agent asset-management snipe-it snipeit windows-agent

Marksman - A Windows agent for Snipe-IT

Installation

  1. Download and install the latest .msi installer from the releases tab.
  2. By default, the program will be installed in Program Files (x86)/Scope-IT/Marksman. Edit the Marksman.exe.config file to include your API key and BaseURI from the default values to the ones given by your Snipe-IT instance.
  3. Set the Company and Location parameters in Marksman.exe.config, then run the .exe.

Features

Getting started

You will need a working Snipe-IT database with API access and an API key. We recommend creating a separate user for the agent with minimal (read + add) permissions.

You can run it via a GPO or Scheduled task (recommended way is to run the agent once on boot with a delay of 1+ minute)

Developer Guide

If you want to not only use Marksman.exe, but edit the sources and build the project, here are some steps for getting started. Marksman has a dependency on our specific fork of SnipeSharp, so you will need to build it as well.

  1. Create a development folder. Inside this folder, clone the following repos:
  2. Open the SnipeSharp project .sln, and build the solution.
  3. Open the marksman project. Check the 'references' under the marksman project, and see if SnipeSharp has been added automatically. Make sure that the path of the SnipeSharp reference points to the repository you just built. If a reference does not exist, you may need to add it manually.
  4. Build the marksman project. It should build correctly - if there are any errors at this stage please file a bug report.
  5. You can now proceed to edit the config file so that your API key and BaseURI correspond to your Snipe-IT instance. Once the config file is set, the program can be run.

Bug Reports & Feature Requests

We welcome community participation in this project. Please submit an issue or pull request to participate in the development.

License

This project is licensed under the Apache 2.0 License

Planned features

Acknowledgments