0ct0pu5/m1k1oblog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

readme proofread

Browse source
This commit is contained in:
Miroslav Šedivý 2019-12-26 22:51:37 +01:00
parent db9ab01aa0
commit a4c80928a1
1 changed files with 32 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
README.md Normal file → Executable file
View file

@ -1,13 +1,13 @@
# blog
This is simple self-hosted lightweight singe-user PHP blog where you can create your own facebook-like feed, give view access to other people and you can share rich text with photos, highlighted code or links.
This is a simple self-hosted, lightweight, singe-user PHP blog, where you can create your own Facebook-like feed. Give read access to other people, and you can share rich text with photos including highlighted code or links.
In this context, lightweight means:
* No npm dependency, there won't be annoying 1GB `node_modules` folder.
* No pipeline. What you see is pure developed code without need to install it.
* No overhead. Just essential features. Simple usage.
In this context lightweight means:
* No npm dependency, there won't be an annoying 1GB `node_modules` directory.
* No pipeline. What you see is pure code without a need to install it.
* No overhead, essential features, simple usage.
## Install standalone app using `docker-compose`
You need to have installed [docker-compose](https://docs.docker.com/compose/install/).
You need to install [docker-compose](https://docs.docker.com/compose/install/).
### Step 1: Clone this repository:
```
@ -20,18 +20,18 @@ cd blog
docker-compose up -d
```
You can specify these environment variables, otherwise there will be used default values:
* **HTTP_PORT=80** - where will be blog accessible.
* **HTTPS_PORT=443** - if you want to use HTTPS.
* **DATA=./data** - directory, where will be stored user data.
You can specify these environment variables, otherwise the default ones will be used:
* **HTTP_PORT=80** - where the blog will be accessible.
* **HTTPS_PORT=443** - if you want to use with HTTPS.
* **DATA=./data** - directory to store the user data.
These environment variables can be stored in `.env` file or passed to command directly:
These environment variables can be stored in the `.env` file or passed to the command directly:
```
HTTP_PORT=3001 HTTPS_PORT=3002 DATA=/home/user/blog docker-compose up -d
```
### Step 3: Copy config
Copy config from root folder to your new `./data/` folder.
### Step 3: Copy the config
Copy the config from the root directory to your new `./data/` directory.
```
cp ./config.ini ./data/config.ini
@ -40,39 +40,39 @@ cp ./config.ini ./data/config.ini
Now you can modify your config.
### Correct permissions
Make sure your `./data/` folder has correct permissions. Apache is running as `www-data` user, that needs to have write access to `./data/` folder (when you upload images).
Make sure your `./data/` directory has correct permissions. Apache is running as a `www-data` user, which needs to have write access to the `./data/` directory (for uploading images).
#### Good solution
Change folder owner to `www-data`:
#### Prefered solution
Change the directory owner to the `www-data` user:
```
chown 33:33 ./data/
```
Alternative: Add `www-data` user to user group, that owns `./data/` folder.
Alternatively, add the `www-data` user to the user group that owns the `./data/` directory.
#### Bad solution (but it works)
Set `777` permission for your `./data/`, so everyone can read, write and execute:
Set `777` permission for your `./data/`, so everyone can read, write, and execute:
```
chmod 777 ./data/
```
**NOTICE:** You should not use `777`, you are giving anyone access to this folder. Maybe to some attacker, who can run his exploit here.
**NOTICE:** You should not use `777`. You are giving access to anyone for this directory. Maybe to some attacker, who can run his exploit here.
## Install using docker
You need to have installed [docker](https://docs.docker.com/install/).
You need to install [docker](https://docs.docker.com/install/).
If you don't want do spawn new database server, but you want to use your existing `mariadb` or `mysql` server, you can install this blog using Docker.
If you don't want do spawn a new database server, but you want to use your existing `mariadb` or `mysql` server, you can install this blog using Docker.
### Build image
After you cloned and accessed repository, you run this command. It will vuild docker image and assign tag `blog`.
After you have cloned and accessed the repository, you need to run this command. It will build a docker image with a tag `blog`.
```
docker build --tag blog .
```
### Run container
After you built image, you can run it like this:
After you have built the image, you can run it as the following:
```
docker run \
@ -82,28 +82,28 @@ docker run \
blog
```
Now you can copy config to your new `./data` folder and set up database connection settings.
Now you can copy the config to your new `./data` directory and set up the database connection settings.
```
cp ./config.ini ./data/config.ini
```
## Install
If you decied you don't want to use docker, you can intall it manually.
If you have decied that you don't want to use Docker, you can intall it manually.
**Requirements:** Apache 2.0*, PHP 7.4, MariaDB 10.1
**NOTICE:** If you would like to use nginx or another web server instead, make sure sensitive data are not exposed to public. Since `.htaccess` is protecting those files in Apache, that could not be the case in different environments. Take care of:
* **config.ini** - disallow access to all *.ini* files for public.
* **data/logs/_ANY_.log** - make sure no sensitive informations are in *.log*.
**NOTICE:** If you would like to use Nginx or another web server, make sure that the sensitive data are not exposed to the public. Since `.htaccess` is protecting those files in Apache, that could not be the case in a different environment. Take care of:
* **config.ini** - disallow access to all *.ini* files for the public.
* **data/logs/\_ANY_.log** - make sure no sensitive information are located in *.log*.
### Database Schema
You can find database schema in `./app/db/01_schema.sql`.
You can find database schema in the `./app/db/01_schema.sql` file.
### Debug mode
You would like to turn on debug mode (in config add `debug = true`) to see, if your server is set up correctly. In debug mode, you will be told if you are missing some **PHP extensions** needed to be installed on your server.
To check if your server is set up correctly, turn on a debug mode (in config add `debug = true`) to see the details. In the debug mode, an error may be shown if you are missing some **PHP extensions** needed to be installed on your server.
## Config file
**DON'T** edit `./config.ini` file, instead copy it to `./data/config.ini` folder and edit it there.
**DO NOT** edit `./config.ini` file. If you wish to modify the config, simply make a copy to the `./data/config.ini` directory and edit it there.
**But, why?** If there is any change in config file (most likely adding a new feature), you will have problems with merging new version. Also, if you would fork this repository, you might accidentally push your secrets to git. We don't want that to happen. Content of folder `/data` is ignored by git, so none of your pictures or personal data should ever be pushed to git.
**But, why?** If there is any change in config file (most likely adding a new feature), you will have problems with merging a new version. Also, if you would fork this repository, you might accidentally push your secrets to the git. We don't want that to happen. Content of the `/data` directory is ignored by the git, so none of your pictures or personal data should ever be published to git.