-
Notifications
You must be signed in to change notification settings - Fork 0
Home
UpCheck is actually two parts, called "UpCheck Server" and "UpCheck Client."
UpCheck-Client resides at your home, is a webserver, and runs speed-tests UpCheck-Server resides on a cloud platform of your choosing, runs outage checks, tweets, and gathers the data from UpCheck-Client.
To run UpCheck you need a few things 1 -- A cloud platform with Docker. I use Digital Ocean with Ubuntu, Docker, and Portainer installed. Do what makes you happy.
2 -- A docker install at home. I still use Ubuntu, Docker, Portainer. Use whatever works for you.
3 -- Routing set up at home so your webserver is accessible to the world - check this before running the server
4 - A Twitter Account and Twitter App Keys
5 - Reasonable confidence that your own network isn't causing your network outages
I'd recommend you start up the client, validate it all works, and then create the server. I suck at Python, so you have been warned.
Clone the upcheck repository
Go to /upcheck/upcheck-server:
cd ./upcheck/upcheck-client
Build the Container
docker build -t upcheck-client .
Make a volume for upcheck to store the database:
docker volume create upcheckdb
Launch the Container
docker run -d --name="upcheck" \ -e UPCHECK_DB_LOCATION=/upcheckdb/upcheck.db
upcheck-client
Clone the upcheck repository
Go to /upcheck/upcheck-server:
cd ./upcheck/upcheck-server
Build the Container
docker build -t upcheck .
Make a volume for upcheck to store the database:
docker volume create upcheckdb
Launch the Container
docker run -d --name="upcheck" \ -e UPCHECK_URLTOCHECK=http://myhomeURL.example \ -e UPCHECK_TWITTER_CONSUMER_KEY=MyTwitterConsumerKey \ -e UPCHECK_TWITTER_CONSUMER_SECRET=MyTwitterConsumerSecret \ -e UPCHECK_TWITTER_ACCESS_TOKEN=MyTwitterAccessToken \ -e UPCHECK_TWITTER_ACCESS_TOKEN_SECRET=MyTwitterAccessTokenSecret \ -e UPCHECK_DB_LOCATION=/upcheckdb/upcheck.db
-e UPCHECK_SPEEDTEST_RESULTS=http://myhomeURL.example/upcheck-speedtest.xml
-e UPCHECK_TARGET_TWITTER_ACCOUNT=@blahblahblah @blahblahblah2
-e UPCHECK_HASHTAGS=#somehashtag #someotherhastag
upcheck