Skip to content

Latest commit

 

History

History
91 lines (68 loc) · 3.03 KB

README.md

File metadata and controls

91 lines (68 loc) · 3.03 KB
Raw

Benotes Logo

Benotes

Benotes Thumbnail

An open source self hosted web app for your notes and bookmarks side by side.

This project is currently in Beta. You may encounter bugs or errors.

Features

  • URLs are automatically saved with an image, title and description
  • supports both markdown and a rich text editor
  • can be installed as a PWA on your mobile devices (and desktop)
  • share content via this app (if installed as an PWA and supported by your browser)
  • collections can be shared via a public available URL
  • links can be instantly pasted as new posts
  • can be hosted almost anywhere thanks to its use of the lightweight Lumen framework and well supported PHP language
  • works with and without a persistent storage layer (both filesystem and S3 are supported)
  • can also be hosted via Docker or on Heroku

Installation & Upgrade

Currently their are three options for you to choose from:

Issues

Feel free to contact me if you need any help or open an issue or a discussion.

Q: Having trouble with reordering posts ?

Use this command in order to fix it.

php artisan fix-position

or if you have already installed newer php versions on your system

/usr/bin/php7.4 artisan fix-position

Backup

Currently SQL Server and backing up S3 storage is not supported.

Backups can be triggered manually by executing the following command:

php artisan backup:run

Or schedule them by adding this line to your servers cron entries:

0 * * * * cd /path-to-your-project && /usr/bin/php7.4 artisan schedule:run >> /dev/null 2>&1

(This will check every hour if there is any task to run)

If you use docker add to your host system cron entries:

0 * * * * cd /path-to-your-project && docker exec -it benotes php artisan schedule:run >> /dev/null 2>&1

By default scheduled backups are created every night. If you wish to change that add the following to your .env file:

BACKUP_INTERVAL = 0 0 */7 * *  // this would translate to a weekly backup

If you wish to store your data with S3 compatible Object Storage (such as AWS S3, Digital Ocean Spaces, Minio, etc.), add the following to your .env file:

BACKUP_DISK           = s3

AWS_ACCESS_KEY_ID     = yourKeyId
AWS_SECRET_ACCESS_KEY = yourAccessKey
AWS_DEFAULT_REGION    = us-east-1
AWS_BUCKET            = yourCreativeBucketName
AWS_ENDPOINT          = endpointUrl

Rest API

Further information can be found here: Rest API Documentation