|
3 | 3 |
|
4 | 4 | The definition of the word exceptionless is: to be without exception. [Exceptionless](http://exceptionless.io) provides real-time .NET error reporting for your ASP.NET, Web API, WebForms, WPF, Console, and MVC apps. It organizes the gathered information into simple actionable data that will help your app become exceptionless! |
5 | 5 |
|
6 | | -*** |
7 | | - |
8 | | -_This branch is for [Exceptionless 2.0] (http://github.com/exceptionless/Exceptionless/wiki/Exceptionless-2.0-Overview) which is a preview version. Please switch to the 1.x branch if you are looking for the stable version._ |
9 | | - |
10 | | -*** |
11 | | - |
12 | 6 | ## Getting Started |
13 | 7 |
|
14 | | -_** NOTE: If you simply want to use Exceptionless, just go to [http://exceptionless.io](http://exceptionless.io) and signup for a free account and you will be up and running in seconds._ |
| 8 | +All of our [.NET clients can be installed](https://www.nuget.org/profiles/exceptionless?showAllPackages=True) via the [NuGet package manager](https://docs.nuget.org/consume/Package-Manager-Dialog). If you need help, please contact us via in-app support or [open an issue](https://github.com/exceptionless/Exceptionless.Net/issues/new). We’re always here to help if you have any questions! |
15 | 9 |
|
16 | 10 | 1. You will need to have [Visual Studio 2013](http://www.visualstudio.com/products/visual-studio-community-vs) installed. |
17 | | -2. Start `Elasticsearch`, `MongoDB` and `Redis` by opening `StartBackendServers.bat`. |
18 | | -3. Install [`Elasticsearch`](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup-service-win.html) if you haven't already. |
19 | | -4. Open the `Exceptionless.sln` Visual Studio solution file. |
20 | | -5. Select `Exceptionless.Api.IIS` and `Exceptionless.SampleConsole` as startup projects. |
21 | | -6. Run the project by pressing `F5` to start the console and server. |
22 | | -7. (OPTIONAL) For a user interface you must also setup and configure the [Exceptionless.UI](https://github.com/exceptionless/Exceptionless.UI) project. |
23 | | - |
24 | | -Alternatively, you can [watch this short YouTube video](http://youtu.be/wROzlVuBoDs) showing how to get started with the project. |
| 11 | +2. Open the `Exceptionless.Net.sln` Visual Studio solution file. |
| 12 | +3. Select `Exceptionless.SampleConsole` as the startup project. |
| 13 | +4. Run the project by pressing `F5` to start the console. |
25 | 14 |
|
26 | 15 | ## Using Exceptionless |
27 | 16 |
|
28 | | -Refer to the Exceptionless documentation here: [Exceptionless Docs](http://docs.exceptionless.io) |
29 | | - |
30 | | -## Hosting Options |
31 | | - |
32 | | -1. We provide very reasonably priced hosting at [Exceptionless](http://exceptionless.io). By using our hosted service, you are supporting the project and helping it get better! We also provide set up and support services. |
33 | | -2. If you would rather host Exceptionless yourself, you will need to follow these steps: |
34 | | - 1. Setup `Elasticsearch` ([Linux](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup-service.html), [Windows](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup-service-win.html)), `Mongo` ([Linux](http://docs.mongodb.org/manual/administration/install-on-linux/), [Windows](http://docs.mongodb.org/manual/tutorial/install-mongodb-on-windows/)) and `Redis `servers ([Linux](http://redis.io/download), [Windows](https://github.com/MSOpenTech/redis)). We highly recommend that you run these on Linux systems because the Windows versions aren't as performant and reliable as the Linux versions. We also highly recommend that you setup Mongo in a replica set configuration. |
35 | | - 2. Enable Web Sockets. |
36 | | - 3. Setup IIS and add the Exceptionless API website ([Download](https://www.myget.org/feed/exceptionless/package/nuget/Exceptionless.Api)). |
37 | | - 4. Modify the connection strings in Web.config to point to your `Elasticsearch`, `MongoDB` and `Redis` servers. |
38 | | - 5. Change the `WebsiteMode` to `Production` in the `Web.config` appSettings section. |
39 | | - 6. [Configure your clients](http://docs.exceptionless.io/contents/configuration/#self-hosted-options) to send errors to your installation. |
40 | | - |
41 | | - |
42 | | -## How is Exceptionless licensed? |
43 | | - |
44 | | -The Exceptionless server is licensed under GNU AGPL v3.0. The client libraries are licensed under Apache License v2.0. |
45 | | - |
46 | | -We want Exceptionless to be free for those of you who want to host the application and data internally or just simply do not want to pay for a hosted account. Our hope is that by making the application free and open source that more people will be aware of it and use it which will indirectly result in more people using our hosted service. |
47 | | - |
48 | | -The server is licensed under the AGPL license to ensure that any modifications that are made will be contributed back to the community. |
49 | | - |
50 | | -We chose to release the client libraries under Apache License v2.0 to remove any ambiguity as to the extent of the server license — you do not have to license any software that uses Exceptionless under AGPL and are completely free to use any licensing mechanism of your choice. |
51 | | - |
52 | | -## Contributing |
53 | | - |
54 | | -Please read the [contributing document](https://github.com/exceptionless/Exceptionless/blob/master/CONTRIBUTING.md). |
55 | | - |
56 | | -In appreciation for anyone who submits a non-trivial pull request, we will give you a free [Exceptionless ](http://exceptionless.io) paid plan for a year. After your pull request is accepted, simply send an email to [email protected] with the name of your organization and we will upgrade you to a paid plan. |
57 | | - |
58 | | -## Roadmap |
59 | | - |
60 | | -This is a list of high level things that we are planning to do: |
61 | | -- ~~Refactor client so that the base client is a PCL library thus supporting WinRT and Mono. **(Completed)**~~ |
62 | | -- ~~Refactor the API to be MUCH simpler and allow for clients to be easily developed while at the same time making the entire sytem much more flexible and able to gather additional data like log messages and feature usage. **(Completed)**~~ |
63 | | -- ~~Implement search features using ElasticSearch. **(Completed)**~~ |
64 | | -- JavaScript client for reporting client side errors. **([In Progress](https://github.com/exceptionless/Exceptionless.JavaScript))** |
65 | | -- ~~Refactor the API and UI to be completely separate layers and rewrite the UI as a SPA app using AngularJS. **(Completed)**~~ |
66 | | -- ~~Add a server side plugin system that allows new functionality to be easily added like HipChat notifications. **(Completed)**~~ |
67 | | - |
68 | | - |
69 | | -##Thanks |
70 | | -Thanks to the community for your support! |
71 | | - |
72 | | -Thanks to [JetBrains](http://jetbrains.com) for a community [WebStorm](https://www.jetbrains.com/webstorm/) and [ReSharper](https://www.jetbrains.com/resharper/) license to use on this project. It's the best JavaScript IDE/Visual Studio productivity enhancement hands down. |
73 | | - |
74 | | -Thanks to [Red Gate](http://www.red-gate.com) for providing an open source license for a [.NET Developer Bundle](http://www.red-gate.com/products/dotnet-development/). It's an indepensible tool when you need to track down a performance/memory issue. |
| 17 | +Refer to the Exceptionless documentation here: [Exceptionless Docs](http://docs.exceptionless.io). |
0 commit comments