BrainDump is a simple, powerful, and open note taking platform that makes it easy to organize your life.
- RESTful API (WIP)
- Full Markdown Editing
- Full Markdown Viewing
- Share Notes via Email
- Categorize Notes into Notebooks
- Categorize Notes with Tags
- Full Text Search
- Mark notes as Favorites
Organize your Notes with Notebooks
All of your Notes in One Place
The easiest way to hack on braindump is with Vagrant
- Fork and Clone this repo locally
cdinto the new repo
- The first time you run
vagrant upthe provisioner (scripts/bootstrap.sh) will run which takes a bit of time. Each subequent time will be much quicker.
vagrant sshto enter the Vagrant box.
- Go to the
cd /vagrantwhich is a synced folder of your local git repo.
scripts/start-dev.shto start the application
- Go to localhost:5000 to view the app, any changes you make locally will be reflected in the Vagrant environment.
Deploying to Production
The only official method of deploying Braindump is with Docker. Braindump.pw is currently running on an Ubuntu 16.04 LTS server on Linode. You can view
scripts/deploy.sh to see how braindump is currently being deployed to production via CircleCI.
- Docker and Docker Compose
- SMTP (Required for Creating new Accounts and Sharing Notes)
Log into your Production Server and install Docker and Docker Compose
Create a new directory for braindump
mkdir -p /var/www/braindump
scripts/secrets.shand add your site specific environment credentials.
etc/conf/nginx.confand add your site specific nginx configuration
From your local repo, send latest scripts to production Server
rsync -avz scripts/ $USER@SERVER:/var/www/braindump/scripts/ rsync -avz etc/ $USER@SERVER:/var/www/braindump/etc/ scp docker-compose.yml $USER@SERVER:/var/www/braindump
From your local repo, log into production server, pull and restart Docker
ssh $USER@SERVER 'cd /var/www/braindump && docker-compose pull' ssh $USER@SERVER 'cd /var/www/braindump && docker-compose build' ssh $USER@SERVER 'cd /var/www/braindump && source scripts/secrets.sh && docker-compose up -d'
(Optional) to set up automatic backups (every 6 hours) add the backup script to your crontab
If all goes well, you will be able to navigate to $YOUR_SERVER in a browser and see the app. If you get a bad gateway error, or some other error try to run docker-compose in the foreground to get additional logging
cd /var/www/braindump && source scripts/secrets.sh && docker-compose up