4 |
2 |
4 |
10 |
11 | An open source self hosted web app for your notes and bookmarks side by side.
12 |
13 | This project is currently in **Beta**. You may encounter bugs or errors.
14 |
15 | ### Features
16 |
17 | - URLs are automatically saved with an image, title and description
18 | - supports both markdown and a rich text editor
19 | - can be installed as a PWA on your mobile devices (and desktop)
20 | - share content via this app (if installed as an PWA and supported by your browser)
21 | - collections can be shared via a public available URL
22 | - links can be instantly pasted as new posts
23 | - can be hosted almost anywhere thanks to its use of the lightweight Lumen framework and well supported PHP language
24 | - works with and without a persistent storage layer (both filesystem and S3 are supported)
25 | - can also be hosted via Docker or on Heroku
26 | - protect your data with daily backups
27 |
28 | ## Installation & Upgrade
29 |
30 | Currently their are three options for you to choose from:
31 |
32 | - [Normal classical way](https://benotes.org/docs/installation/classic)
33 | - [Docker](https://benotes.org/docs/installation/docker)
34 | - [Docker Compose](https://benotes.org/docs/installation/docker-compose)
35 | - [Heroku](https://benotes.org/docs/installation/heroku) ([not free anymore](https://blog.heroku.com/next-chapter))
36 |
37 | ## Additional Features
38 |
39 | - [Backups](https://benotes.org/docs/extras/backup)
40 | - [Bookmarklet](https://benotes.org/docs/extras/bookmarklet)
41 |
42 | ## Issues
43 |
44 | 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).
45 |
46 | Q: Having trouble with **reordering** posts ?
47 |
48 | Use this command in order to fix it.
49 |
50 | ```
51 | php artisan fix-position
52 | ```
53 |
54 | or if you have already installed newer php versions on your system:
55 |
56 | ```
57 | /usr/bin/php7.4 artisan fix-position
58 | ```
59 |
60 | ## Rest API
61 |
62 | Further information can be found here: [Rest API Documentation](api.md)
63 |
--------------------------------------------------------------------------------
/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "Benotes",
3 | "description": "An open source web app for your notes & bookmarks.",
4 | "repository": "https://github.com/fr0tt/benotes",
5 | "logo": "https://raw.githubusercontent.com/fr0tt/benotes/master/public/logo_144x144.png",
6 | "keywords": [
7 | "laravel",
8 | "lumen",
9 | "vue"
10 | ],
11 | "addons": [
12 | "heroku-postgresql"
13 | ],
14 | "scripts": {
15 | "postdeploy": []
16 | },
17 | "env": {
18 | "APP_NAME": "Benotes",
19 | "APP_ENV": "production",
20 | "APP_DEBUG": "false",
21 | "APP_KEY": {
22 | "generator": "secret"
23 | },
24 | "JWT_SECRET": {
25 | "generator": "secret"
26 | },
27 | "USE_FILESYSTEM": "false",
28 | "TRUSTED_PROXIES": "*",
29 | "LOG_CHANNEL": "errorlog",
30 | "DB_CONNECTION": "pgsql"
31 | }
32 | }
--------------------------------------------------------------------------------
/app/Console/Commands/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/fr0tt/benotes/cb803b32340eb7720131a9d0b93261d01800c896/app/Console/Commands/.gitkeep
--------------------------------------------------------------------------------
/app/Console/Commands/ExportCommand.php:
--------------------------------------------------------------------------------
1 | info('Export a collection:');
36 | $collection_id = $this->ask('Collection Id');
37 | $email = $this->ask('Email address of its owner');
38 |
39 | $validator = Validator::make([
40 | 'collection_id' => $collection_id,
41 | 'email' => $email
42 | ], [
43 | 'collection_id' => 'integer',
44 | 'email' => 'email',
45 | ]);
46 |
47 | if ($validator->fails()) {
48 | foreach ($validator->errors()->all() as $error) {
49 | $this->error($error);
50 | }
51 | return;
52 | }
53 |
54 | $user = User::where('email', $email)->firstOrFail();
55 |
56 | $collection = Collection::where('id', $collection_id)->where('user_id', $user->id)->firstOrFail();
57 |
58 | $posts = Post::select('title', 'content')
59 | ->where('collection_id', $collection_id)
60 | ->whereNull('deleted_at')
61 | ->orderBy('order', 'desc')
62 | ->get();
63 |
64 | $filename = date('Y-m-d') . '_' . $collection->name . '.json';
65 | file_put_contents('database/data/' . $filename, json_encode($posts, JSON_PRETTY_PRINT));
66 |
67 | $this->line(PHP_EOL);
68 | $this->info('Export completed.');
69 | }
70 | }
71 |
--------------------------------------------------------------------------------
/app/Console/Commands/FixPositionCommand.php:
--------------------------------------------------------------------------------
1 | get();
36 | foreach ($users as $user) {
37 | $user_id = $user->id;
38 | $collections = Collection::select('id', 'name')
39 | ->where('user_id', $user_id)
40 | ->get();
41 | $uncategorized = new stdClass;
42 | $uncategorized->id = null;
43 | $uncategorized->name = 'Uncategorized';
44 | $collections->push($uncategorized);
45 | foreach ($collections as $collection) {
46 | echo '------- ' . $collection->name . ' by ' . $user->name . ':' . ' -------' . PHP_EOL;
47 | $collection_id = $collection->id;
48 | $posts = Post::where('user_id', $user_id)
49 | ->where('collection_id', $collection_id)
50 | ->where('deleted_at', null)
51 | ->orderBy('order')
52 | ->get();
53 | for ($i = 0; $i < $posts->count(); $i++) {
54 | $post = $posts[$i];
55 | $post->order = $i + 1;
56 | $post->save();
57 | echo $post['order'] . ': ' . $post['title'] . PHP_EOL;
58 | };
59 | }
60 | }
61 |
62 | $this->info('completed.');
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/app/Console/Commands/RetryMigrationCommand.php:
--------------------------------------------------------------------------------
1 | info('Migrate database...');
45 |
46 | for ($i = 0; $i < 3; $i++) {
47 |
48 | try {
49 | DB::connection()->getPDO();
50 | Artisan::call('migrate --force');
51 | $this->info('Database migration completed.');
52 | return 0;
53 | } catch(\Exception $e) {
54 | sleep(5 + $i);
55 | $this->info('Database migration failed. Try again...');
56 | }
57 | }
58 |
59 | try {
60 | DB::connection()->getPDO();
61 | Artisan::call('migrate --force');
62 | $this->info('Database migration completed.');
63 | return 0;
64 | } catch(\Exception $e) {
65 | $this->error('Database migration failed.');
66 | Log::error('Database migration failed.');
67 | }
68 |
69 |
70 | return 0;
71 | }
72 | }
73 |
--------------------------------------------------------------------------------
/app/Console/Commands/ThumbnailCommand.php:
--------------------------------------------------------------------------------
1 | service = new PostService;
36 | }
37 |
38 | /**
39 | * Execute the console command.
40 | *
41 | * @return int
42 | */
43 | public function handle()
44 | {
45 |
46 | $post_id = $this->argument('id');
47 | if (empty($post_id)) {
48 | $this->info('What post would you like to "improve" ?');
49 | $post_id = $this->ask('Please specify a post id or type all');
50 | }
51 |
52 | if ($post_id === 'all') {
53 | $posts = Post::whereNull('deleted_at')
54 | ->where('type', Post::POST_TYPE_LINK)
55 | ->whereNull('image_path');
56 | $this->info($posts->count() . ' potential posts found. This could take several minutes.');
57 | foreach ($posts->get() as $post) {
58 | $this->info('Process post ' . $post->id . '...');
59 | $this->createThumbnail($post);
60 | }
61 | return 0;
62 | } else {
63 | $post = Post::find(intval($post_id));
64 | $this->createThumbnail($post);
65 | }
66 |
67 | return 0;
68 | }
69 |
70 | private function createThumbnail(Post $post)
71 | {
72 | if ($post->type === Post::POST_TYPE_TEXT) {
73 | $this->error('Post is not a link and therefore has no thumbnail');
74 | return;
75 | }
76 |
77 | if (@get_headers($post->url) == false) {
78 | $this->error('Post has no existing link');
79 | return;
80 | }
81 |
82 | $filename = $this->service->generateThumbnailFilename($post->url, $post->id);
83 | $path = $this->service->getThumbnailPath($filename);
84 | $this->service->crawlWithChrome($filename, $path, $post->url, $post->id);
85 | if (file_exists($path)) {
86 | $post->image_path = $filename;
87 | $post->save();
88 | } else {
89 | $this->error('Thumbnail could not be created');
90 | }
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/app/Console/Kernel.php:
--------------------------------------------------------------------------------
1 | command('backup:run')->cron(config('benotes.backup_interval'));
23 | }
24 | if (config('benotes.generate_missing_thumbnails')) {
25 | $schedule->command('queue:work --max-jobs=10 --tries=3 --stop-when-empty')
26 | ->cron(config('benotes.thumbnail_filler_interval'));
27 | }
28 | }
29 |
30 | /**
31 | * Register the commands for the application.
32 | *
33 | * @return void
34 | */
35 | protected function commands()
36 | {
37 | $this->load(__DIR__ . '/Commands');
38 |
39 | require base_path('routes/console.php');
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/app/Exceptions/Handler.php:
--------------------------------------------------------------------------------
1 | >
16 | */
17 | protected $dontReport = [
18 | AuthorizationException::class,
19 | HttpException::class,
20 | //ModelNotFoundException::class,
21 | ValidationException::class,
22 | ];
23 |
24 | /**
25 | * A list of the inputs that are never flashed for validation exceptions.
26 | *
27 | * @var arrayExport bookmarks from Benotes. You can use them in your favorite 10 | web browser or somewhere else accepting NETSCAPE-Bookmark files.
11 |15 | This may take a minute. 16 |
17 |{{ error }}
21 || Name | 11 |13 | | {{ user.name }} | 21 |{{ user.email }} | 22 |23 | Owner 28 | | 29 |
|---|