Nemcio/Chevereto
1
0
Fork 0
mirror of https://github.com/chevereto/chevereto.git synced 2025-10-26 00:36:15 +02:00
Code Issues Packages Projects Releases Activity

Update README.md

Browse Source
This commit is contained in:
Rodolfo Berrios
2024-04-20 09:39:39 -04:00
committed by GitHub
parent 5ca43087dd
commit 8117e52ef3
1 changed files with 101 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

190
README.md
View File

@@ -20,94 +20,104 @@ Chevereto is a turnkey system which main use case is to provide a self-hosted pl
![screen](.github/screen/user-profile.jpeg)
## Documentation
Chevereto is so **feature-rich**, mature and robust that we need three layers of documentation for it. The project started on 2007 and it has been actively maintained since then.
- [Documentation](https://v4-docs.chevereto.com)
- [User manual](https://v4-user.chevereto.com/)
- [Admin manual](https://v4-admin.chevereto.com/)
**Note:** This is the repository for Chevereto free edition. This software is intended for **personal usage** as it doesn't contain [all the features](https://chevereto.com/features) of commercial editions. This is a short, not exhaustive, list of features available on Chevereto editions. Feel free to request a free demo of the pro edition at [chevereto.com](https://chevereto.com) to see all the features in action.
| Feature | Free | Pro |
| ------------------------------------------------------------------------------- | -------- | -------------------- |
| Image & Video uploads | ✅ | ✅ |
| Supports 360° images | ✅ | ✅ |
| User profiles | ✅ | ✅ |
| Albums | ✅ | ✅ |
| Categories | ✅ | ✅ |
| Search | ✅ | ✅ |
| Direct links | ✅ | ✅ |
| Delete link | ✅ | ✅ |
| Sharing | ✅ | ✅ |
| Admin web interface | ✅ | ✅ |
| Listings | ✅ | ✅ |
| EXIF data | ✅ | ✅ |
| User-based API | ✅ | ✅ |
| Two-Factor Authentication (2FA) | ✅ | ✅ |
| Call-to-action albums | ✅ | ✅ |
| Random button | ✅ | ✅ |
| Encrypt secrets | ✅ | ✅ |
| System stats & usage | ✅ | ✅ |
| Custom semantics | ✅ | ✅ |
| One-click upgrade (web & CLI) | ✅ | ✅ |
| Theme palettes (10) | ✅ | ✅ |
| Custom JS & CSS | ✅ | ✅ |
| Supports GD & ImageMagick | ✅ | ✅ |
| Duplicate media detection | ✅ | ✅ |
| Docker support | ✅ | ✅ |
| CLI commands | ✅ | ✅ |
| Multiple languages (configurable) | ✅ | ✅ |
| Website mode (public, private) | ✅ | ✅ |
| Default timezone selection | ✅ | ✅ |
| Enable/disable NSFW listings | ✅ | ✅ |
| Enable/disable blur NSFW content | ✅ | ✅ |
| Classic + Endless scroll listings | ✅ | ✅ |
| Configurable listings | ✅ | ✅ |
| Anywhere uploader | ✅ | ✅ |
| Embed codes on upload complete | ✅ | ✅ |
| Embed codes on selected media | ✅ | ✅ |
| Embed codes media view | ✅ | ✅ |
| Expirable uploads | ✅ | ✅ |
| Storage modes (date, direct) | ✅ | ✅ |
| Filenaming (original, id, random, mixed) | ✅ | ✅ |
| Thumbs & medium sized images | ✅ | ✅ |
| CDN support (any) | ✅ | ✅ |
| Maintenance mode | ✅ | ✅ |
| Crypt-salted IDs (no public integer ids) | ✅ | ✅ |
| Comments API (Disqus, any JS) | ✅ | ✅ |
| Email SMTP + phpmail() | ✅ | ✅ |
| Test-email tool | ✅ | ✅ |
| Debugger included ([xrDebug](https://xrdebug.com)) | ✅ | ✅ |
| REPL included ([PsySH](https://psysh.org), [Tinkerwel](https://tinkerwell.app)) | ✅ | ✅ |
| Source code available | ✅ | ✅ |
| Maximum resolution | No limit | No limit |
| License | AGPLv3 | Not-AGPL limited |
| Roles | admin | admin, manager, user |
| Multiple users & management | – | ✅ |
| Multiple external storage servers | – | ✅ |
| Explore & Discovery | – | ✅ |
| Advanced search | – | ✅ |
| Followers | – | ✅ |
| Guest API | – | ✅ |
| Likes | – | ✅ |
| Manage banners | – | ✅ |
| Consent screen (age gate) | – | ✅ |
| Bulk content importer | – | ✅ |
| Stop words | – | ✅ |
| Custom homepage | – | ✅ |
| Custom logo | – | ✅ |
| Custom pages | – | ✅ |
| Custom routing | – | ✅ |
| Cookie consent | – | ✅ |
| Notifications | – | ✅ |
| Queue handling | – | ✅ |
| IP banning | – | ✅ |
| Upload moderation | – | ✅ |
| Upload plugin (PUP.js) | – | ✅ |
| Image watermarks | – | ✅ |
| External services support | – | ✅ |
| StopForumSpam | – | ✅ |
| ModerateContent | – | ✅ |
| Project Arachnid | – | ✅ |
| Auth providers (OAuth2) | – | ✅ |
| Feature | Free | Pro |
| ------------------------------------------------------------------------------- | -------- | --------------------- |
| Image & Video uploads | ✅ | ✅ |
| ShareX support | ✅ | ✅ |
| Supports 360° images | ✅ | ✅ |
| User profiles | ✅ | ✅ |
| Albums & Sub-albums | ✅ | ✅ |
| Categories | ✅ | ✅ |
| Search | ✅ | ✅ |
| Direct links | ✅ | ✅ |
| Delete link | ✅ | ✅ |
| Sharing | ✅ | ✅ |
| oEmbed | ✅ | ✅ |
| Admin web interface | ✅ | ✅ |
| Media, Album and Users listings | ✅ | ✅ |
| EXIF data | ✅ | ✅ |
| User-based API | ✅ | ✅ |
| Two-Factor Authentication (2FA) | ✅ | ✅ |
| Call-to-action albums | ✅ | ✅ |
| Random button | ✅ | ✅ |
| Encrypt secrets | ✅ | ✅ |
| System stats & usage | ✅ | ✅ |
| Custom semantics | ✅ | ✅ |
| One-click upgrade (web & CLI) | ✅ | ✅ |
| Theme palettes (10) | ✅ | ✅ |
| Custom JS & CSS | ✅ | ✅ |
| Supports GD & ImageMagick | ✅ | ✅ |
| Duplicate media detection | ✅ | ✅ |
| Docker support | ✅ | ✅ |
| CLI commands | ✅ | ✅ |
| Multiple languages (configurable) | ✅ | ✅ |
| Website mode (public, private) | ✅ | ✅ |
| Default timezone selection | ✅ | ✅ |
| Enable/disable NSFW listings | ✅ | ✅ |
| Enable/disable blur NSFW content | ✅ | ✅ |
| Classic + Endless scroll listings | ✅ | ✅ |
| Configurable listings | ✅ | ✅ |
| Anywhere uploader | ✅ | ✅ |
| Embed codes on upload complete | ✅ | ✅ |
| Embed codes on selected media | ✅ | ✅ |
| Embed codes media view | ✅ | ✅ |
| Expirable uploads | ✅ | ✅ |
| Storage modes (date, direct) | ✅ | ✅ |
| Filenaming (original, id, random, mixed) | ✅ | ✅ |
| Thumbs & medium sized images | ✅ | ✅ |
| CDN support (any) | ✅ | ✅ |
| Maintenance mode | ✅ | ✅ |
| Crypt-salted IDs (no public integer ids) | ✅ | ✅ |
| Comments API (Disqus, any JS) | ✅ | ✅ |
| Email SMTP + phpmail() | ✅ | ✅ |
| Test-email tool | ✅ | ✅ |
| Debugger included ([xrDebug](https://xrdebug.com)) | ✅ | ✅ |
| REPL included ([PsySH](https://psysh.org), [Tinkerwel](https://tinkerwell.app)) | ✅ | ✅ |
| Source code available | ✅ | ✅ |
| Maximum resolution | No limit | No limit |
| License | AGPLv3 | Not-AGPL |
| Roles | admin | admin, manager & user |
| Multiple users & management | – | ✅ |
| Multiple external storage servers | – | ✅ |
| Explore & Discovery | – | ✅ |
| Advanced search | – | ✅ |
| Followers | – | ✅ |
| Guest API | – | ✅ |
| Likes | – | ✅ |
| Manage banners | – | ✅ |
| Consent screen (age gate) | – | ✅ |
| Bulk content importer | – | ✅ |
| Stop words | – | ✅ |
| Custom homepage | – | ✅ |
| Custom logo | – | ✅ |
| Custom pages | – | ✅ |
| Custom routing | – | ✅ |
| Cookie consent | – | ✅ |
| Notifications | – | ✅ |
| Queue handling | – | ✅ |
| IP banning | – | ✅ |
| Upload moderation | – | ✅ |
| Upload plugin (PUP.js) | – | ✅ |
| Image watermarks | – | ✅ |
| External services support | – | ✅ |
| StopForumSpam | – | ✅ |
| ModerateContent | – | ✅ |
| Project Arachnid | – | ✅ |
| Auth providers (OAuth2) | – | ✅ |
## Files supported
You can upload the following media types:
With Chevereto you can upload and share the following media types:
- image/jpeg
- image/gif
@@ -117,13 +127,15 @@ You can upload the following media types:
- video/mp4
- video/webm
## Documentation
## Supported servers
Chevereto is so **feature-rich**, mature and robust that we need three layers of documentation for it. The project started on 2007 and it has been actively maintained since then.
Chevereto works anywhere:
- [Documentation](https://v4-docs.chevereto.com)
- [User manual](https://v4-user.chevereto.com/)
- [Admin manual](https://v4-admin.chevereto.com/)
- Shared hosting ([cPanel](https://v4-docs.chevereto.com/guides/cpanel/), [Plesk](https://v4-docs.chevereto.com/guides/plesk/), DirectAdmin, etc)
- [VPS](https://v4-docs.chevereto.com/guides/server/vps) (DigitalOcean, Linode, Vultr, etc)
- [Docker](https://github.com/chevereto/docker) (x86_64, arm64)
- [PURE DOCKER](https://v4-docs.chevereto.com/guides/docker/pure-docker)
- [Chevereto Docker](https://v4-docs.chevereto.com/guides/docker/)
## License
@@ -135,7 +147,7 @@ This program is free software: you can redistribute it and/or modify it under th
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see [GNU Licenses](http://www.gnu.org/licenses/).
### Commercial license