From b36f094eddebae228d5b6c3b341766f501ccba4e Mon Sep 17 00:00:00 2001 From: Rodolfo Berrios <20590102+rodber@users.noreply.github.com> Date: Sat, 4 Dec 2021 12:26:16 -0300 Subject: [PATCH] close #131 --- README.md | 49 +++++-------------------- docs/BUILDING.md | 17 --------- docs/COMPOSE.md | 53 --------------------------- docs/DEVELOPMENT.md | 88 --------------------------------------------- 4 files changed, 8 insertions(+), 199 deletions(-) delete mode 100644 docs/BUILDING.md delete mode 100644 docs/COMPOSE.md delete mode 100644 docs/DEVELOPMENT.md diff --git a/README.md b/README.md index b20788b..951880a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Chevereto-Free allows you to create a full-featured image hosting website on your own server. It's your hosting and your rules, say goodbye to closures and restrictions. -## Screens +## ✨ Screens ![Homepage](.github/screen/1a.webp) @@ -18,9 +18,9 @@ Chevereto-Free allows you to create a full-featured image hosting website on you ![Dashboard](.github/screen/6a.webp) -## About this fork +## πŸ¦“ About this fork -Chevereto-Free is forked from [Chevereto V3.16.2](https://releases.chevereto.com/3.X/3.16/3.16.2.html) in which only basic features are preserved. This fork was created for personal usage and small communities. +Chevereto-Free is a fork from [Chevereto V3.16.2](https://releases.chevereto.com/3.X/3.16/3.16.2.html) in which only basic features are preserved. Chevereto-Free is for personal usage and small communities. πŸ‘‰ **This fork removes** @@ -34,7 +34,7 @@ Chevereto-Free is forked from [Chevereto V3.16.2](https://releases.chevereto.com πŸ‘‰ **This fork misses** -* All updates (non-security) added in [V3.17](https://releases.chevereto.com/3.X/3.17/3.17.2.html), [V3.18](https://releases.chevereto.com/3.X/3.18/3.18.3.html) and [V3.20](https://releases.chevereto.com/3.X/3.20/3.20.12.html) including: +* All updates (non-security) added in [V3.17](https://releases.chevereto.com/3.X/3.17/3.17.2.html), [V3.18](https://releases.chevereto.com/3.X/3.18/3.18.3.html) and [V3.20](https://releases.chevereto.com/3.X/3.20/3.20.15.html) including: * 360 images * Nested albums * ImageMagick support @@ -43,50 +43,17 @@ Chevereto-Free is forked from [Chevereto V3.16.2](https://releases.chevereto.com * 12FA Support * CLI API -## Requirements +## 🧐 Requirements * PHP 7.4 * MySQL 5.7 / 8 - MariaDB 10 * Apache HTTP Web Server * mod_rewrite -## Installation +## πŸ“š Documentation -### Docker +[chevereto-free.github.io](https://chevereto-free.github.io) -To install using Docker: - -* [COMPOSE](docs/COMPOSE.md) -* [DEVELOPMENT](docs/DEVELOPMENT.md) - -To build Docker tagged images: - -* [BUILDING](docs/BUILDING.md) - -### cPanel - -* Check the [Chevereto cPanel setup](https://chevereto-free.github.io/setup/server/cpanel.html). - -### Composer-based installation - -* Requires [Composer](https://getcomposer.org) - -```sh -composer create-project rodber/chevereto-free . \ - --repository='{ - "url": "https://github.com/rodber/chevereto-free.git", - "type": "vcs" - }' \ - --remove-vcs \ - --ignore-platform-reqs -``` - -### Manual installation - -* Pick the [latest release](https://github.com/rodber/chevereto-free/releases/latest) -* Download the tagged `$TAG.zip` release artifact -* Unzip the release in your target `public` web-server directory - -## License +## πŸ“œ License Copyright [Rodolfo BerrΓ­os Arce](http://rodolfoberrios.com) - [AGPLv3](LICENSE). diff --git a/docs/BUILDING.md b/docs/BUILDING.md deleted file mode 100644 index 5c9b2a9..0000000 --- a/docs/BUILDING.md +++ /dev/null @@ -1,17 +0,0 @@ -# Building - -## Docker build - -* **Tip:** Tag `ghcr.io/rodber/chevereto-free:1.6` to override the [ghcr package](https://github.com/rodber/chevereto-free/pkgs/container/chevereto-free) with local - -```sh -docker build -t ghcr.io/rodber/chevereto-free:1.6 . \ - -f httpd-php.Dockerfile -``` - -* For custom tag: Replace `tag` with your own. - -```sh -docker build -t rodber/chevereto-free:tag . \ - -f httpd-php.Dockerfile -``` diff --git a/docs/COMPOSE.md b/docs/COMPOSE.md deleted file mode 100644 index bef92bd..0000000 --- a/docs/COMPOSE.md +++ /dev/null @@ -1,53 +0,0 @@ -# Compose - -Compose file: [httpd-php.yml](../httpd-php.yml) - -## Up - -Run this command to spawn (start) Chevereto-Free. - -```sh -docker-compose \ - -p chevereto-free \ - -f httpd-php.yml \ - up --abort-on-container-exit -``` - -[localhost:8810](http://localhost:8810) - -## Stop - -Run this command to stop Chevereto-Free. - -```sh -docker-compose \ - -p chevereto-free \ - -f httpd-php.yml \ - stop -``` - -## Start - -Run this command to start Chevereto if stopped. - -```sh -docker-compose \ - -p chevereto-free \ - -f httpd-php.yml \ - start -``` - -### Down (uninstall) - -Run this command to down Chevereto (stop containers, remove networks and volumes created by it). - -```sh -docker-compose \ - -p chevereto-free \ - -f httpd-php.yml \ - down --volumes -``` - -## Logs - -`todo` diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md deleted file mode 100644 index 7489706..0000000 --- a/docs/DEVELOPMENT.md +++ /dev/null @@ -1,88 +0,0 @@ -# Development - -## Quick start - -* Clone [rodber/chevereto-free](https://github.com/rodber/chevereto-free) -* Run [docker-compose up](#up) -* [Sync code](#sync-code) to sync changes - -## Reference - -* `SOURCE` is the absolute path to the cloned chevereto project -* You need to replace `SOURCE=~/git/rodber/chevereto-free` with your own path -* `SOURCE` will be mounted at `/var/www/source/` inside the container -* Chevereto will be available at [localhost:8910](http://localhost:8910) - -✨ This dev setup mounts `SOURCE` to provide the application files to the container. We provide a sync system that copies these files on-the-fly to the actual application runner for better isolation. - -## docker-compose - -Compose file: [httpd-php-dev.yml](../httpd-php-dev.yml) - -Alter `SOURCE` in the commands below to reflect your project path. - -## Up - -Run this command to spawn (start) Chevereto Installer. - -```sh -SOURCE=~/git/rodber/chevereto-free \ -docker-compose \ - -p chevereto-free-dev \ - -f httpd-php-dev.yml \ - up -d -``` - -## Stop - -Run this command to stop Chevereto Installer. - -```sh -SOURCE=~/git/rodber/chevereto-free \ -docker-compose \ - -p chevereto-free-dev \ - -f httpd-php-dev.yml \ - stop -``` - -## Start - -Run this command to start Chevereto if stopped. - -```sh -SOURCE=~/git/rodber/chevereto-free \ -docker-compose \ - -p chevereto-free-dev \ - -f httpd-php-dev.yml \ - start -``` - -## Down (uninstall) - -Run this command to down Chevereto (stop containers, remove networks and volumes created by it). - -```sh -SOURCE=~/git/rodber/chevereto-free \ -docker-compose \ - -p chevereto-free-dev \ - -f httpd-php-dev.yml \ - down --volumes -``` - -## Sync code - -Run this command to sync the application code with your working project. - -```sh -docker exec -it \ - chevereto-free-dev_app \ - bash /var/www/sync.sh -``` - -This system will observe for changes in your working project filesystem and it will automatically sync the files inside the container. - -**Note:** This command must keep running to provide the sync functionality. You should close it once you stop working with the source. - -## Logs - -`todo`