https://github.com/fr0tt/benotes

An open source self hosted notes and bookmarks taking web app.
https://github.com/fr0tt/benotes

bookmarks database docker laravel notes php posts vue

Last synced: about 1 month ago
JSON representation

An open source self hosted notes and bookmarks taking web app.

• Host: GitHub
• URL: https://github.com/fr0tt/benotes
• Owner: fr0tt
• License: mit
• Created: 2019-10-30T14:19:53.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T12:56:22.000Z (8 months ago)
• Last Synced: 2024-04-22T14:02:04.148Z (8 months ago)
• Topics: bookmarks, database, docker, laravel, notes, php, posts, vue
• Language: PHP
• Homepage: https://benotes.org
• Size: 14.6 MB
• Stars: 655
• Watchers: 8
• Forks: 43
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• deploy-your-own-saas - Benotes
• awesome-homelab - Benotes

README

        


    



Benotes




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

-   protect your data with daily backups

## Installation & Upgrade

Currently their are three options for you to choose from:

-   [Normal classical way](https://benotes.org/docs/installation/classic)

-   [Docker](https://benotes.org/docs/installation/docker)

-   [Docker Compose](https://benotes.org/docs/installation/docker-compose)

-   [Heroku](https://benotes.org/docs/installation/heroku) ([not free anymore](https://blog.heroku.com/next-chapter))

## Additional Features

-   [Backups](https://benotes.org/docs/extras/backup)

-   [Bookmarklet](https://benotes.org/docs/extras/bookmarklet)

## Issues

Feel free to [contact me](https://twitter.com/_fr0tt) if you need any help or open an [issue](https://github.com/fr0tt/benotes/issues) or a [discussion](https://github.com/fr0tt/benotes/discussions) or join the [subreddit](https://reddit.com/r/benotes).

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

```

## Rest API

Further information can be found here: [Rest API Documentation](api.md)