Skip to content

Commit

Permalink
docs: update configuration in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tanhongit committed Nov 24, 2023
1 parent c413f9e commit 9ebb75a
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ and manage customization through messages and buttons on Telegram.
[![Total Downloads](https://img.shields.io/packagist/dt/cslant/laravel-telegram-git-notifier.svg?style=flat-square)](https://packagist.org/packages/cslant/laravel-telegram-git-notifier)
![Test Status](https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/setup_test.yml?label=tests&branch=main)
![Code Style Status](https://img.shields.io/github/actions/workflow/status/cslant/laravel-telegram-git-notifier/php-cs-fixer.yml?label=code%20style&branch=main)
[![StyleCI](https://styleci.io/repos/656960426/shield)](https://styleci.io/repos/656960426)
[![StyleCI](https://styleci.io/repos/683727144/shield)](https://styleci.io/repos/683727144)
[![Quality Score](https://img.shields.io/scrutinizer/g/cslant/laravel-telegram-git-notifier.svg?style=flat-square)](https://scrutinizer-ci.com/g/cslant/laravel-telegram-git-notifier)
[![Maintainability](https://api.codeclimate.com/v1/badges/7ccaccebe9cd58ff3df5/maintainability)](https://codeclimate.com/github/cslant/laravel-telegram-git-notifier/maintainability)

Expand Down Expand Up @@ -36,3 +36,21 @@ Publication of configuration files:
```bash
php artisan vendor:publish --provider="CSlant\LaravelTelegramGitNotifier\Providers\TelegramGitNotifierServiceProvider" --tag="config_jsons"
```

## Fixing Permissions (for Linux)

If you are using Linux, you need to change the owner of the configuration files to the web server user and group (e.g. `www-data`).

The configuration files will be used to store the bot's settings and other information, so you need to change the owner of the configuration files to the web server user and group.

```bash
sudo php artisan config-json:change-owner www-data www-data
```

> Note:
> - `www-data` is the user and group of the web server, you can change it to your own user and group.
> - The first `www-data` is the user, and the second `www-data` is the group. (You can also use only the first `www-data` to represent both the user and the group)
## 📖 Documentation

...In construction...

0 comments on commit 9ebb75a

Please sign in to comment.