Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rodber committed Jun 25, 2020
1 parent df31514 commit 9730520
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 38 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Introduction

Welcome to the Chevereto documentation. Here you will find all the resources that you need to know to get into the system. This documentation always refers to the last version so to use this documentation properly make sure you have your website updated.
> This is the documentation for both Chevereto V3 and Chevereto-Free
## Localized translations
Here you will find all the (known) resources that you need to know to get into the system. This documentation covers V3 and any user is welcome to collaborate improving this documentation.

You can also browse a [Chinese version](https://ch.cndrew.cn/) of this documentation (thanks to [](https://cndrew.cn/)Uncle_drew).
## Localized Translations

## Our philosophy
You can also browse a [Chinese version](https://ch.cndrew.cn/) of this documentation (thanks to [Uncle_drew](https://cndrew.cn/)).

## Our Philosophy

Chevereto is an application which allows you to setup your own image sharing website. Our goal is to allow anyone to self-host their own image sharing service. We believe in build a real alternative for those who want a customized white-label image sharing service.

## Help and support
## Help and Support

If you need help with something don't hesitate to ask for [support](https://chevereto.com/support).
11 changes: 6 additions & 5 deletions setup/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ Debug refers to ways to detect issues in your installation. Doing debug is the o

Chevereto exception handler includes 4 debug levels that you can configure to meet your needs. The debug levels are detailed in the following table:

- Level Description
- 0 None
- 1 Error log (default)
- 2 Print errors without error log
- 3 Print and log errors
Level | Description
----- | ------------------------------
0 | None
1 | Error log (default)
2 | Print errors without error log
3 | Print and log errors

Default debug level is Error log (1) and to change this you must edit the `app/settings.php` file. If your settings file doesn't have the `debug_level` property here is a sample:

Expand Down
33 changes: 13 additions & 20 deletions setup/install.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,37 @@
Install
=======
# Install

If you have a VPS or dedicated server, follow our [Root install (LEMP)](./root-install.md) guide. For everything else, make sure that your server meets all the [system requirements](./requirements.md) then do one of the following procedures:

A. Install using our Installer
------------------------------
## A. Install using our Installer

The installer is a single `.php` file which will download and extract the latest release.

* Upload the [installer](https://chevereto.com/download/file/installer) to your target destination (usually the `public_html` folder).
* Open your website at `/installer.php` and follow the process.
- Upload the [installer](https://chevereto.com/download/file/installer) to your target destination (usually the `public_html` folder).
- Open your website at `/installer.php` and follow the process.

B. Install via zip
------------------
## B. Install via zip

* Download the [latest release](https://chevereto.com/panel/downloads)
* Upload all the contents of the `chevereto` folder to your server (usually in the `public_html` folder)
* Go to your target website URL and follow the instructions
- Download the [latest release](https://chevereto.com/panel/downloads)
- Upload all the contents of the `chevereto` folder to your server (usually in the `public_html` folder)
- Go to your target website URL and follow the instructions

C. Install using Softaculous/Fantastico
---------------------------------------
## C. Install using Softaculous/Fantastico

If your web hosting includes [Softaculous](https://softaculous.com/)/[Fantastico](https://netenberg.com/fantastico.php), you can install Chevereto-Free with just one click, it should be available for one-click install under the "Image Galleries" category.

**Note:** Our paid edition isn't available in any of these script libraries. However, you can install Chevereto Free and then **one-click upgrade** it to the paid edition directly from the dashboard panel.

D. Install using Docker
-----------------------
## D. Install using Docker

Docker allows you to easily install and maintain all the server dependencies with ease by using automated application containers. The ready-to-use Docker images are under [nmtan/chevereto](https://hub.docker.com/r/nmtan/chevereto/) (many thanks to [Tan Nguyen](https://github.com/tanmng)).

**Note:** Use the `installer` tag to use Docker with our paid edition.

Install issues
--------------
## Install issues

Most common install issue is missing [system requirements](./requirements.md) so make sure that you are running a compatible system and that all the data is correct like working MySQL credentials and privileges. For other issues feel free to ask for [support](https://chevereto.com/support).

app/settings.php
----------------
## app/settings.php

This file contains the application settings like DB credentials and other settings. This file may look like this:

Expand All @@ -53,4 +46,4 @@ $settings['db_pass'] = 'password';
$settings['db_table_prefix'] = 'chv_';
$settings['db_driver'] = 'mysql';
$settings['debug_level'] = 1;
```
```
16 changes: 8 additions & 8 deletions setup/root-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This guide is for **Ubuntu 18.04.3 (LTS) x64** and it will install Chevereto in

Domain name (without www.) Guide for domain: example.com

## 0\. Prepare the system
## Prepare the system

Before begin, make sure that the base system is updated.

Expand All @@ -14,13 +14,13 @@ sudo apt update && sudo apt upgrade

Go with the recommended option if asked about updating or keep packages.

## 1\. Install NGINX
## Install NGINX

```
sudo apt install nginx
```

## 2\. Install MySQL database
## Install MySQL database

```
sudo apt install mysql-server
Expand Down Expand Up @@ -59,7 +59,7 @@ Remove test database and access to it? [Y/n] y
Reload privilege tables now? [Y/n] y
```

## 3\. Install PHP
## Install PHP

```
sudo apt install php-fpm php-zip php-curl php-mbstring php-gd php-mysql
Expand All @@ -82,7 +82,7 @@ memory_limit = 512M;

Write close `Ctrl+o Ctrl+x`.

## 4\. Setup the website
## Setup the website

Create the path for the website files and assign the `www-data` owner and group.

Expand Down Expand Up @@ -162,7 +162,7 @@ sudo systemctl restart php7.2-fpm
sudo systemctl restart nginx
```

## 5\. Setup HTTPS
## Setup HTTPS

Install the Certbot and web server-specific packages, then run Certbot.

Expand All @@ -175,7 +175,7 @@ Answer yes when it ask if you will like to automatically redirect HTTP traffic t

When the tool completes, Certbot will update your web server configuration so that it uses the new certificate.

## 6\. Install Chevereto
## Install Chevereto

Download the installer to your website directory, masked as www-data.

Expand All @@ -185,7 +185,7 @@ sudo -u www-data wget -O /var/www/html/example.com/public_html/installer.php htt

Open your website at `/installer.php`, follow the process (ignore the warning about Nginx rules). Once done, go to the dashboad and make sure that the connecting IP match yours.

## 7\. Real connecting IP (CloudFlare, optional)
## Real connecting IP (CloudFlare, optional)

If you run CloudFlare you will need to configure the `ngx_http_realip_module`. Install the CloudFlare IP ranges sync script.

Expand Down

0 comments on commit 9730520

Please sign in to comment.