Take back control of your GitHub Notifications with Octobox.
Why is this a thing?
If you manage more than one active project on GitHub, you probably find GitHub Notifications pretty lacking.
Notifications are marked as read and disappear from the list as soon as you load the page or view the email of the notification. This makes it very hard to keep on top of which notifications you still need to follow up on.
Most open source maintainers and GitHub staff end up using a complex combination of filters and labels in Gmail to manage their notifications from their inbox. If, like me, you try to avoid email, then you might want something else.
Octobox adds an extra "archived" state to each notification so you can mark it as "done". If new activity happens on the thread/issue/pr, the next time you sync the app the relevant item will be unarchived and moved back into your inbox.
What state is the project in right now?
You can use a hosted version right now.
You could also host it yourself, in Heroku or otherwise.
Check out the open issues for a glimpse of the future: https://github.com/octobox/octobox/issues.
Web notifications must be enabled in your GitHub settings for Octobox to work: https://github.com/settings/notifications
Deployment to Heroku
You can host your own instance of Octobox using Heroku. Heroku will ask you to provide a 'personal access token' which you can create on GitHub. When creating it, make sure you enable the notifications scope on it.
In order to setup Octobox for your GitHub Enterprise instance all you need you do is add your enterprise domain to the
.env file / deployed environment.
And that's it
Using Personal Access Tokens
Octobox can optionally allow you to set a personal access token to use when querying for notifications. This must be enabled
at the server level. In order to enable it, add the environment variable
PERSONAL_ACCESS_TOKENS_ENABLED to the
.env file / deployed environment.
Once that is set, users can set a personal access token on the Settings page (found on the user drop-down menu).
New to Ruby? No worries! You can follow these instructions to install a local server, or you can use the included Vagrant setup.
Prefer PHP? We got you covered! There is a (work-in-progress) PHP version called LaraGit.
Installing a Local Server
brew install rbenv ruby-build rbenv install 2.4.0 rbenv global 2.4.0
Next, you'll need to make sure that you have PostgreSQL installed. This can be done easily on OSX using Homebrew or by using http://postgresapp.com. Please see these further instructions for installing Postgres via Homebrew.
brew install postgres
On Debian-based Linux distributions you can use apt-get to install Postgres:
sudo apt-get install postgresql postgresql-contrib libpq-dev
Now, let's install the gems from the
Gemfile ("Gems" are synonymous with libraries in other
gem install bundler && rbenv rehash bundle install
Once all the gems are installed, we'll need to create the databases and tables. Rails makes this easy through the use of "Rake" tasks:
bundle exec rake db:create db:migrate
Now go and register a new GitHub OAuth Application, your development configuration should look something like this:
If you're deploying this to production, just replace
http://localhost:3000 with your applications URL.
Once you've created your application you can then then add the following to your
Finally you can boot the rails app:
You can use Docker to run Octobox in development.
First, install Docker. If you've got run macOS or Windows, Docker for Mac/Windows makes this really easy.
GITHUB_CLIENT_ID=yourclientid GITHUB_CLIENT_SECRET=yourclientsecret docker-compose up --build
Octobox will be running on http://localhost:3000.
Note: You can add
GITHUB_CLIENT_SECRET to a
.env file instead of supplying them directly on the command-line.
Sync notifications automatically
Now that you've set all to go you can configure the app to sync the notifications automatically, there is a rake task that will do this for every user
You will need to configure this to run automatically
Create a Heroku Scheduler
heroku addons:create scheduler:standard
Visit the Heroku Scheduler resource and add a new job to run
rake tasks:sync_notifications daily
Add the following
@daily cd octobox_path && /usr/local/bin/rake RAILS_ENV=production tasks:sync_notifications
To find the full path for your rake executable, run
You can use keyboard shortcuts to navigate and perform certain actions:
a- Select/deselect all
.- refresh list
j- move down the list
k- move up the list
s- star current notification
x- mark/unmark current notification
e- archive current/marked notification(s)
m- mute current/marked notification(s)
d- mark current/marked notification(s) as read here and on GitHub
Enter- open current notification in a new window
? for the help menu.
Note on Patches/Pull Requests
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so we don't break it in a future version unintentionally.
- Send a pull request. Bonus points for topic branches.
Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Copyright (c) 2017 Andrew Nesbitt. See LICENSE for details.