mirror of
https://github.com/openclassify/openclassify.git
synced 2026-01-11 18:01:10 -06:00
Readme update
This commit is contained in:
fatihalp
parent
4390603cdd
commit
ca916e4455
111
README.md
111
README.md
@ -4,7 +4,9 @@
|
||||
</p>
|
||||
<br>
|
||||
<p align="center">
|
||||
<a href="https://packagist.org/packages/openclassify/openclassify" target="_blank"><img class="badge" src="http://poser.pugx.org/openclassify/openclassify/v"></a>
|
||||
<a href="https://packagist.org/packages/openclassify/openclassify" target="_blank">
|
||||
<img class="badge" src="http://poser.pugx.org/openclassify/openclassify/v">
|
||||
</a>
|
||||
<a href="https://packagist.org/packages/openclassify/openclassify" target="_blank"><img class="badge" src="http://poser.pugx.org/openclassify/openclassify/downloads"></a>
|
||||
<a href="https://packagist.org/packages/openclassify/openclassify" target="_blank"><img class="badge" src="http://poser.pugx.org/openclassify/openclassify/license"></a>
|
||||
<a href="https://scrutinizer-ci.com/g/openclassify/openclassify/?branch=master" rel="nofollow"><img src="https://camo.githubusercontent.com/b1809c56d5b15765dabaf72c173e7f9aba9e7b721ccb0036e9db5da62869e6b1/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6f70656e636c6173736966792f6f70656e636c6173736966792f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572" alt="Scrutinizer Code Quality" data-canonical-src="https://scrutinizer-ci.com/g/openclassify/openclassify/badges/quality-score.png?b=master" style="max-width: 100%;"></a>
|
||||
@ -14,18 +16,18 @@
|
||||
|
||||
|
||||
|
||||
## About OpenClassify
|
||||
### About OpenClassify
|
||||
|
||||
OpenClassify is modular and most advanced open source classified platform build with Laravel 8 & PHP 8.1 Supported. Included Pyrocms 3.9
|
||||
OpenClassify is modular and most advanced open source classified platform build with Laravel included Pyrocms.
|
||||
|
||||
|
||||
## Translation
|
||||
### Translation
|
||||
|
||||
Openclassify support 22+ languages. If you'd like to contribute translations, please check out our [Crowdin](https://crowdin.com/project/openclassify) project.
|
||||
|
||||
## Server Requirements
|
||||
### Server Requirements
|
||||
|
||||
- Supports PHP 7.3 and later (8.1 Supported)
|
||||
- Only PHP > 8.2 Officially Supported!
|
||||
- XML PHP Extension
|
||||
- PDO PHP Extension
|
||||
- cURL PHP Extension
|
||||
@ -40,99 +42,38 @@ Openclassify support 22+ languages. If you'd like to contribute translations, pl
|
||||
- GD Library (>=2.0) **OR** Imagick PHP extension (>=6.5.7)
|
||||
|
||||
|
||||
## Via Composer
|
||||
|
||||
> Do not create an `.env` file just yet - Installer will generate one for you.{.important}
|
||||
## Install Via Docker
|
||||
|
||||
We suggest to use Docker. Install Docker and run it.
|
||||
|
||||
1- Clone project
|
||||
```bash
|
||||
composer create-project openclassify/openclassify
|
||||
git clone https://github.com/openclassify/openclassify.git
|
||||
```
|
||||
or use your IDE (like VS Code Or PHPStorm)
|
||||
|
||||
### Via Docker
|
||||
|
||||
We suggest to use Docker.
|
||||
|
||||
https://github.com/openclassify/openclassify/wiki/Installing-Openclassify-on-windows-docker-desktop
|
||||
|
||||
### Host Configuration
|
||||
|
||||
When you setup your web host be sure to point the web root to `public` directory. Just as you would a normal Laravel installation.
|
||||
|
||||
#### Alternate Directories for cPanel or Virtualmin
|
||||
|
||||
In some environments like cPanel or Virtualmin it may be difficult to use the `public` directory as the web root. In these cases we suggest symlinking the `public` directory to `public_html`:
|
||||
|
||||
2- Run install.sh
|
||||
```bash
|
||||
ln -s public public_html
|
||||
bash install.sh
|
||||
```
|
||||
Open project at [localhost](http://localhost)
|
||||
|
||||
You may also simply rename the `public` directory to `public_html`. Path hints will automatically use the correct path.
|
||||
Nginx, Mysql and PHP 8.2 installed. MacOS, Windows and Ubuntu is supported.
|
||||
|
||||
### Directory Permissions
|
||||
Watch in on [Youtube](https://www.youtube.com/watch?v=vVpVmsxq-Z0&t=27s&pp=ygUTb3BlbmNsYXNzaWZ5IGRvY2tlcg%3D%3D)
|
||||
|
||||
After installing, you may need to configure some permissions in order to proceed. Directories within the `storage`, `public/app`, and the `bootstrap/cache` directories should be writable by your web server. If you are using the [Homestead](http://laravel.com/docs/homestead) virtual machine, these permissions should already be set.
|
||||
## Other Installation Methods
|
||||
|
||||
Check [here](https://github.com/openclassify/openclassify/blob/master/docs/other-install-methods.md) for more.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Running the Installation Wizard
|
||||
|
||||
After downloading and it's dependencies with:
|
||||
|
||||
```bash
|
||||
composer install
|
||||
```
|
||||
you will need to install the software in order to get started.
|
||||
By this time you should be able to visit your site's URL which will
|
||||
redirect you to the installer: `http://yoursite.com/installer`
|
||||
|
||||
### Using the CLI Installer
|
||||
|
||||
|
||||
```bash
|
||||
php artisan install
|
||||
|
||||
```
|
||||
|
||||
You will be prompted for details in order to proceed with the installation process.
|
||||
|
||||
> You may need to run `ulimit -n 1024` before installing via CLI to temporarily increase your max open files limit.
|
||||
|
||||
#### Automating the CLI Installer
|
||||
|
||||
You can automate the installer by creating your own .env file with something like this:
|
||||
|
||||
```bash
|
||||
APP_ENV=local
|
||||
APP_DEBUG=true
|
||||
APP_KEY=zfesbnTkXvooWVcsKMw2r4SmPVNGbFoS
|
||||
DB_CONNECTION=mysql
|
||||
DB_HOST=localhost
|
||||
DB_DATABASE=workbench
|
||||
DB_USERNAME=root
|
||||
DB_PASSWORD=root
|
||||
APPLICATION_NAME=Default
|
||||
APPLICATION_REFERENCE=default
|
||||
APPLICATION_DOMAIN=localhost
|
||||
ADMIN_EMAIL=info@openclassify.com
|
||||
ADMIN_USERNAME=admin
|
||||
ADMIN_PASSWORD=password
|
||||
LOCALE=en
|
||||
TIMEZONE=Turkey/Istanbul
|
||||
```
|
||||
> The APP_KEY must be exactly 32 characters in length.
|
||||
|
||||
Then run the installer and indicate that the system is ready to install:
|
||||
|
||||
```bash
|
||||
php artisan install --ready
|
||||
```
|
||||
|
||||
## CLI Commands
|
||||
### CLI Commands
|
||||
|
||||
If you couldn't find a solution for any problem, please review our CLI Command document.
|
||||
[View CLI Command Document](https://github.com/openclassify/openclassify/blob/master/docs/cli-commands.md)
|
||||
|
||||
|
||||
## Code Contributors
|
||||
|
||||
This project exists thanks to all the people who [contribute](https://github.com/openclassify/openclassify/graphs/contributors) and more.
|
||||
@ -143,6 +84,4 @@ This project exists thanks to all the people who [contribute](https://github.com
|
||||
<img src = "https://contrib.rocks/image?repo=openclassify/openclassify"/>
|
||||
</a>
|
||||
|
||||
</p>
|
||||
|
||||
Thanks to Ryan and his stream platform PyroCMS which makes OpenClassify more powerful.
|
||||
</p>
|
||||
@ -13,7 +13,6 @@ else
|
||||
echo "env file exists. nothing to do."
|
||||
fi
|
||||
|
||||
# .env dosyasını oku ve değişkenleri tanımla
|
||||
while IFS= read -r line || [[ -n "$line" ]]; do
|
||||
if [[ "$line" == "INSTALLED="* ]]; then
|
||||
installed="${line#*=}"
|
||||
@ -22,7 +21,6 @@ while IFS= read -r line || [[ -n "$line" ]]; do
|
||||
fi
|
||||
done < .env
|
||||
|
||||
# installed değişkenini kontrol et
|
||||
if [ "$installed" = "false" ]; then
|
||||
echo ".env installed is false starting installing"
|
||||
php artisan install --ready
|
||||
|
||||
@ -231,3 +231,28 @@ Use the `--force` flag to overwrite the files should they already exist.
|
||||
```bash
|
||||
php artisan addon:publish anomaly.module.store --force
|
||||
```
|
||||
|
||||
|
||||
### Migrate All Addons
|
||||
|
||||
```bash
|
||||
php artisan migrate --all-addons --force
|
||||
```
|
||||
|
||||
### Run Command Inside Docker
|
||||
|
||||
```bash
|
||||
docker exec -it oc_php php artisan install --ready
|
||||
```
|
||||
|
||||
### Composer set private repo
|
||||
|
||||
```bash
|
||||
composer config repositories.repo-name composer https://abc.aaa.com
|
||||
```
|
||||
|
||||
|
||||
### Composer set username and password for repo
|
||||
```bash
|
||||
composer config http-basic.abc.aaa.com openclassify pass
|
||||
```
|
||||
84
docs/other-install-methods.md
Normal file
84
docs/other-install-methods.md
Normal file
@ -0,0 +1,84 @@
|
||||
|
||||
## Via Composer
|
||||
|
||||
> Do not create an `.env` file just yet - Installer will generate one for you.{.important}
|
||||
|
||||
```bash
|
||||
composer create-project openclassify/openclassify
|
||||
```
|
||||
|
||||
### Host Configuration
|
||||
|
||||
When you setup your web host be sure to point the web root to `public` directory. Just as you would a normal Laravel installation.
|
||||
|
||||
#### Alternate Directories for cPanel or Virtualmin
|
||||
|
||||
In some environments like cPanel or Virtualmin it may be difficult to use the `public` directory as the web root. In these cases we suggest symlinking the `public` directory to `public_html`:
|
||||
|
||||
```bash
|
||||
ln -s public public_html
|
||||
```
|
||||
|
||||
You may also simply rename the `public` directory to `public_html`. Path hints will automatically use the correct path.
|
||||
|
||||
### Directory Permissions
|
||||
|
||||
After installing, you may need to configure some permissions in order to proceed.
|
||||
Directories within the `storage`, `public/app`, and the `bootstrap/cache` directories should be writable by your web server.
|
||||
If you are using the [Homestead](http://laravel.com/docs/homestead) virtual machine, these permissions should already be set.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Running the Installation Wizard
|
||||
|
||||
After downloading and it's dependencies with:
|
||||
|
||||
```bash
|
||||
composer install
|
||||
```
|
||||
you will need to install the software in order to get started.
|
||||
By this time you should be able to visit your site's URL which will
|
||||
redirect you to the installer: `http://yoursite.com/installer`
|
||||
|
||||
### Using the CLI Installer
|
||||
|
||||
|
||||
```bash
|
||||
php artisan install
|
||||
|
||||
```
|
||||
|
||||
You will be prompted for details in order to proceed with the installation process.
|
||||
|
||||
> You may need to run `ulimit -n 1024` before installing via CLI to temporarily increase your max open files limit.
|
||||
|
||||
#### Automating the CLI Installer
|
||||
|
||||
You can automate the installer by creating your own .env file with something like this:
|
||||
|
||||
```bash
|
||||
APP_ENV=local
|
||||
APP_DEBUG=true
|
||||
APP_KEY=zfesbnTkXvooWVcsKMw2r4SmPVNGbFoS
|
||||
DB_CONNECTION=mysql
|
||||
DB_HOST=localhost
|
||||
DB_DATABASE=workbench
|
||||
DB_USERNAME=root
|
||||
DB_PASSWORD=root
|
||||
APPLICATION_NAME=Default
|
||||
APPLICATION_REFERENCE=default
|
||||
APPLICATION_DOMAIN=localhost
|
||||
ADMIN_EMAIL=info@openclassify.com
|
||||
ADMIN_USERNAME=admin
|
||||
ADMIN_PASSWORD=password
|
||||
LOCALE=en
|
||||
TIMEZONE=Turkey/Istanbul
|
||||
```
|
||||
> The APP_KEY must be exactly 32 characters in length.
|
||||
|
||||
Then run the installer and indicate that the system is ready to install:
|
||||
|
||||
```bash
|
||||
php artisan install --ready
|
||||
```
|
||||
@ -39,9 +39,4 @@ if [[ $(which docker) && $(docker --version) ]]; then
|
||||
fi
|
||||
|
||||
cp .env-sail .env
|
||||
docker compose up
|
||||
#php artisan migrate --all-addons --force
|
||||
#docker exec -it oc_php php artisan install --ready
|
||||
|
||||
#composer config http-basic.abc.aaa.com openclassify pass
|
||||
#composer config repositories.repo-name composer https://abc.aaa.com
|
||||
docker compose up
|
||||
Loading…
Reference in New Issue
Block a user