{"id":18841630,"url":"https://github.com/alphasights/walnut","last_synced_at":"2025-04-14T07:31:02.575Z","repository":{"id":142036046,"uuid":"2123632","full_name":"alphasights/walnut","owner":"alphasights","description":"Lightweight, simplistic dashboard to monitor web services, CI and applications","archived":true,"fork":false,"pushed_at":"2016-10-21T03:04:47.000Z","size":73,"stargazers_count":36,"open_issues_count":2,"forks_count":6,"subscribers_count":60,"default_branch":"master","last_synced_at":"2025-02-22T12:21:36.130Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alphasights.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2011-07-29T11:54:15.000Z","updated_at":"2025-01-29T22:34:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"4d51741c-0ed5-4e5f-ad99-3e980c499fdc","html_url":"https://github.com/alphasights/walnut","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasights%2Fwalnut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasights%2Fwalnut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasights%2Fwalnut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasights%2Fwalnut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphasights","download_url":"https://codeload.github.com/alphasights/walnut/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248839317,"owners_count":21169791,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T02:52:02.156Z","updated_at":"2025-04-14T07:31:02.558Z","avatar_url":"https://github.com/alphasights.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Walnut\n=================\n\nThis is a tiny pure JS/HTML/CSS app for monitoring third party services, integrating with CI, London metro or whatever you like and displaying it on your wall!\n\nFeatures\n========\n\n* No deployment: JS only\n* Five visual states for services\n* Plays the [inception](http://inception.davepedu.com/) sound if a service fails\n* Polls server every 20 seconds\n* Non-blocking\n* Good for displaying on a flatscreen TV\n\n\u003cimg src=\"http://i.imgur.com/4lKdJ6X.jpg?1\"/\u003e\n\n[Screenshot](http://i.imgur.com/U8nTW.png?6291)\n\nService States\n--------------\n\n* Green: up and running\n* Red: service is misbehaving\n* Polling service: making HTTP request to a status api/page\n* Pending: good for CI build/test process\n* Unknown: HTTP request to a status page/api has failed\n\nLimitations\n==========\n\nDue to security reasons browsers do not allow cross-domain AJAX requests, therefore you have to configure your browser accordingly. Please do so at your own risk!\n\nSafari\n------\n\nSeems to work by default.\n\nChrome\n------\n\nYou will have to disable web security. Pass `-disable-web-security` when starting chrome.\nEg. in OS X:\n\n    open /Applications/Google\\ Chrome.app --args -disable-web-security\n\nOther Browsers\n--------------\n\nHaven't tested yet. Please report in Issues if you can get it running on other browsers.\n\nMonitored Services\n==================\n\n* Heroku Apps\n* Heroku Tools\n* Amazon EC2 N.Virginia (Heroku lives there)\n* MongoHQ Rose\n* Mongolab DB\n* Pusher App\n* Rackspace Email\n* Github\n* Cloudmailin\n* Exceptional\n* London Underground Jubilee line (!)\n* Twilio\n* Plex\n* SickBeard\n* Couch Potato\n* SABnzbd\n\nMonitoring other services\n=========================\n\nIt is very easy to add any service you want. Just add another service to the `services.js` file. Here's a helpful example:\n\n    Service({\n      name: 'Some Cool Apps',                 // will be displayed in the view\n      url: 'https://example.com/status.json', // url to call\n      dataType: \"json\",                       // optional. datatype to set in http header\n      username: 'jamesbond',                  // optional. http basic auth username\n      password: 'secret007',                  // optional. http basic auth password\n\n                                              // a function to parse the response.\n                                              // must return true, false or \"pending\"\n      status: function(response) {            // In case of HTML response jQuery can be used\n        return JSON.parse(response)[\"status\"] == \"ok\";\n      }\n    });\n\nMonitoring Jenkins CI\n----------------------\n\nExample of how to monitor Jenkins CI. Will display grey icon while building\n\n    Service({\n      name: 'Jenkins',\n      url: 'http://myjenkinsurl.com/job/Prject/lastBuild/api/json',\n      username: 'jenkinsuser',\n      password: 'someweirdpassword',\n      dataType: \"json\",\n      status: function(response) {\n        if(response[\"building\"]){\n          return \"pending\";\n        };\n        return response[\"result\"].toLowerCase() == \"success\";\n      }\n    });\n\nYou shouldn't need to touch `app.js` at all.\n\nHTTPS URLs using self-signed certificates\n-----------------------------------------\n\nYou may want to monitor an HTTPS service that uses a self-signed certificate. Your\nbrowser will abort request unless you trust that certificate. To do so, open the \nservice's URL in your browser, and accept whatever security exception your browser\nrequires.\n\nStyling\n=======\n\nYou should modify `src/screen.sass`. To compile it to css just run `sass src/screen.sass stylesheets/screen.css` in a project directory. You can also modify `stylesheets/screen.css` directly if you can't use sass for some serious reason.\n\nContributing\n============\n\nPlease make pull requests with useful services to monitor, SASS/CSS styles, new fancy sounds or any other cool features.\n\nCredits\n=======\n\nJohn Griffin, Tor Erik Linnerud, Tadas Tamosauskas\n\nIcons: [Glyphish free icon set](http://glyphish.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphasights%2Fwalnut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphasights%2Fwalnut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphasights%2Fwalnut/lists"}