Skip to content
Self-hosted platform to keep and share your content: web links, posts, passwords and pictures.
PHP Vue HTML
Branch: dev
Clone or download
Latest commit 55ffd89 Dec 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows 💚 Github action workflow Nov 26, 2019
app 🔖 1.2.35 Dec 8, 2019
bootstrap 🎉 Aug 22, 2019
config Ability to choose prefered posts order #61 🐛 Typos on Story form Nov 24, 2019
database 🐛 Temp sharing for albums 🐛 LinkForm test 🔧 Vue components for tests Nov 26, 2019
documentation Comments system Nov 24, 2019
public 🔒 JS security update 📦 Laravel 6.6 Dec 8, 2019
resources 🐛 Temp sharing for albums 🐛 LinkForm test 🔧 Vue components for tests Nov 26, 2019
routes 🚧 Comments: moderate, notification, security Nov 22, 2019
storage 🚧 Locale settings Aug 29, 2019
tests 🔧 LinkForm test 🔧 CI build with PHP 7.2 and 7.3 Nov 26, 2019
.editorconfig 🎉 Aug 22, 2019
.env.example ♻️ Laravel Shaarli is now Shaark #54 Nov 14, 2019
.env.testing ♻️ Laravel Shaarli is now Shaark #54 Nov 14, 2019
.gitattributes 🎉 Aug 22, 2019
.gitignore 🚧 Album Nov 5, 2019
.styleci.yml 🎉 Aug 22, 2019
artisan 🎉 Aug 22, 2019
changelog.md 🔒 JS security update 📦 Laravel 6.6 Dec 8, 2019
composer.json 🐛 Symfony dependencies Nov 24, 2019
composer.lock 🔒 JS security update 📦 Laravel 6.6 Dec 8, 2019
directory.md ♻️ Laravel Shaarli is now Shaark #54 Nov 14, 2019
package-lock.json 🔒 JS security update 📦 Laravel 6.6 Dec 8, 2019
package.json 🔒 JS security update 📦 Laravel 6.6 Dec 8, 2019
phpunit.dusk.xml 💚 Github action workflow Nov 26, 2019
readme.md 📝 Readme Nov 23, 2019
server.php 🎉 Aug 22, 2019
webpack.mix.js 🐛 Markdown editor will now load correct language pack Nov 7, 2019

readme.md

Logo Shaark

Shaark is a self-hosted platform to keep and share your content: web links, posts, passwords and pictures.

All of your data can be private, public or both and can be browsed by tags or all-in-one search.

Shaark is production ready, inspired by Shaarli and built with Laravel and Vue.js.

Summary

Features / Demo / Documentation / Contribute / Security / Tests / Licence

Features

  • Links : to keep your bookmarks
  • Stories : posts with markdown flavored content
  • Chests : to save your passwords
  • Albums : to host your pictures
  • Rapid sharing extension and Progressive Web App
  • Tagging system, search and RSS feeds
  • Private content or entirely private (with temp sharing)
  • Theming (dark mode, background)
  • i18n (🇬🇧, 🇫🇷, 🇩🇪, 🇯🇵)
  • Archiving (as pdf, as media)
  • DB encryption, 2-FA, Multi-users, backup

Demo

Homepage

A public demo is available at https://shaark.mka.ovh. Credentials are admin@example.com and secret. This demo is resetted hourly.

Documentation

Contribute

Features and bugs

All contributions are welcome! Please use the dev branch for your pull requests.
If you make changes to JS, don't compile assets in production, I'll manually compile them when merging for security reasons.

Translation

Shaark is actually available in English, French and German. Feel free to make a pull request to add or update a localization. You can see laravel base localizations on this repo.

Your Shaark

You host your own Shaark public instance and you want to share it with other users? You can make a pull request to add it to our public listing located at directory.md.

Security

If you find any security issues, please send me an email (can be found in composer.json).

Global privacy

If you don't want your content being publicy accessible, you can update this preference once application is installed from settings section.

2-FA

You're able to active 2-FA (2 factors authentication). By default 2-FA is disabled but you can update it from your app settings. Code length and code expiration are also configurable. Test if you application can send emails before enabling this feature.

Auth monitoring

Shaark logs all successful and failed auths with their associated devices.

Chests encryption

Since 1.2.9, all chests data are encrypted in your database using AES-256-CBC and your app key.

Multi-users

Others users can be admin or non-admin. Admin users are like the main user and have an access to the entire content. Non-admin users can't access the settings section and can only see their own private content.

Tests

  1. Be sure to have a testing database with touch database/testing.sqlite and have composer require-dev dependencies installer.
  2. Run testing server php artisan serve --env=testing.
  3. Run tests php artisan dusk --env=testing

Licence

MIT

You can’t perform that action at this time.