Hello everybody! Notorious aims to be a highy extensible tracker implemented in golang. Right now, Notorious uses Redis to store peer information for quick retrieval and to alleviate some of the burden of storing peer information from the tracker itself. Moreover, some of the core functionalities which Notorious hopes to gain include the following:
1. Improved ratio tracking using a SQL (using an ORM, so it's preference).
2. IPV6 support
3. UDP & HTTPS tracking (only supports HTTP right now)
4. Speed and scalability are always in the back of my mind, even if my decisions don't always reflect that
5. Remove technical debt. I learned go from this project, so there's definitely non-idiomatic and idiotic code in places.
There's probably a lot more! Check out my issues page
And here for what's planned to be in the next release: Milestone 0.5.0
Deployment is one of the funnest things from this project for me so far because I've gotten to use a lot of cloud technologies which I typically wouldn't get to deal with. As of the moment, I'm using Docker Cloud and deploying to a 5 $ Digital Ocean droplet. As you'll see, there's a dockerfile in my repo as well as a supervisord.conf and to build it, you'd want to run:
go build main.go
docker build -t notorious .
and then you can run
docker run <-d> -p 3000:3000 notorious (where the <> indicate the -d is optional, it starts it in daemon mode)
Et voilà, you have a copy of notorious running,.
This will build the docker image which you can then run it either on local bare-metal, or if you're interested in the Docker Cloud route (which I highly recommend) head over to their Documentation They'll explain deployment 1 000% better than I can.
I have not yet included instructions for running everything on bare-metal and I'm using docker because it just works (sorry, I try to keep the buzzwordiness down [despite deploying notorious with redis, docker, go...]), but those are soon to come. I just honestly thing the docker way is 10x (just like me, heh) easier to deploy with at this particular moment.
Notorious is a project which I've had a ton of fun learning Go in, but do realize I'm still learning Go so I do make non-idiomatic decisions. If you see anywhere that you think I could improve my code or golang usage, please:
The MIT License (MIT)
Copyright (c) 2016 Ian Clark
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.