Skip to content

Commit 098162a

Browse files
hatamiarash7actions-user
authored andcommitted
[CI] Format Code!
Format code using Prettier
1 parent a3aa07d commit 098162a

File tree

12 files changed

+169
-166
lines changed

12 files changed

+169
-166
lines changed

src/SUMMARY.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Summary
22

3-
- [نیکاس](index.md)
4-
- [نمونه های مشابه](similar.md)
5-
- [شروع به کار](getting-started/index.md)
6-
- [نیازمندی ها](getting-started/requirements.md)
7-
- [نصب](getting-started/install.md)
8-
- [اجرا](getting-started/run.md)
9-
- [تنظیمات](config/index.md)
10-
- [سرور](config/server.md)
11-
- [کلاینت](config/client.md)
12-
- [داکر](config/docker.md)
3+
- [نیکاس](index.md)
4+
- [نمونه های مشابه](similar.md)
5+
- [شروع به کار](getting-started/index.md)
6+
- [نیازمندی ها](getting-started/requirements.md)
7+
- [نصب](getting-started/install.md)
8+
- [اجرا](getting-started/run.md)
9+
- [تنظیمات](config/index.md)
10+
- [سرور](config/server.md)
11+
- [کلاینت](config/client.md)
12+
- [داکر](config/docker.md)

src/config/client.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ or
121121

122122
برای مثال اگر مقدار این گزینه را برابر `"3,3-"` قرار دهید باعث می‎شود حالات زیر اتفاق بیوفتد :
123123

124-
- ایجاد کلاس `nikas-vote-level-0` برای نظرات با امتیاز کمتر از `منفی 3`
125-
- ایجاد کلاس `nikas-vote-level-1` برای نظرات با امتیاز بین `منفی 3` و `دو`
126-
- ایجاد کلاس `nikas-vote-level-2` برای نظرات با امتیاز `دو` و بیشتر
124+
- ایجاد کلاس `nikas-vote-level-0` برای نظرات با امتیاز کمتر از `منفی 3`
125+
- ایجاد کلاس `nikas-vote-level-1` برای نظرات با امتیاز بین `منفی 3` و `دو`
126+
- ایجاد کلاس `nikas-vote-level-2` برای نظرات با امتیاز `دو` و بیشتر
127127

128128
می‎توانید از این کلاس ها برای ظاهرسازی مناسب نظرات استفاده کنید. برای مثال به ازای امتیاز برای آن ها از آیکون ستاره استفاده کنید.
129129

@@ -137,8 +137,8 @@ or
137137

138138
با استفاده از این گزینه می‎توانید قالب پیشفرض نیکاس را انتخاب کنید. دو مقدار معتبر وجود دارد :
139139

140-
- `light` : قالب روشن
141-
- `dark` : قالب تیره
140+
- `light` : قالب روشن
141+
- `dark` : قالب تیره
142142

143143
> در صورتی که مقدار وارد شده معتبر نباشد ٬ قالب روشن استفاده خواهد شد.
144144

src/config/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
در این بخش تنظیمات نیکاس را به صورت **سرور** و **کلاینت** بررسی می‎کنیم.
44

5-
- [سرور](server.md)
6-
- [کلاینت](client.md)
5+
- [سرور](server.md)
6+
- [کلاینت](client.md)
77

88
همچنین به بررسی تنظیمات لازم برای Docker می‎پردازیم
99

10-
- [داکر](docker.md)
10+
- [داکر](docker.md)

src/config/server.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ env NIKAS_SETTINGS=path/to/nikas.cfg nikas
2828

2929
حال به بررسی تنظیمات مختلف سرور می‎پردازیم :
3030

31-
- [General](#general)
32-
- [Moderation](#moderation)
33-
- [Server](#server)
34-
- [SMTP](#smtp)
35-
- [Guard](#guard)
36-
- [Hash](#hash)
37-
- [RSS](#rss)
38-
- [Admin](#admin)
31+
- [General](#general)
32+
- [Moderation](#moderation)
33+
- [Server](#server)
34+
- [SMTP](#smtp)
35+
- [Guard](#guard)
36+
- [Hash](#hash)
37+
- [RSS](#rss)
38+
- [Admin](#admin)
3939

4040
## General
4141

@@ -85,8 +85,8 @@ host =
8585

8686
سیستم اعلام دریافت نظر برای نظرات جدید :
8787

88-
- **stdout** : این مورد به صورت پیشفرض فعال بوده و نظرات جدید در قالب خروجی عادی در ترمینال نمایش داده می‎شوند
89-
- **smtp** : اعلان از طریق ایمیل برای شما ارسال خواهد شد. توجه داشته باشید که در صورت استفاده از این گزینه باید تنظیمات [SMTP](#smtp) را نیز انجام دهید.
88+
- **stdout** : این مورد به صورت پیشفرض فعال بوده و نظرات جدید در قالب خروجی عادی در ترمینال نمایش داده می‎شوند
89+
- **smtp** : اعلان از طریق ایمیل برای شما ارسال خواهد شد. توجه داشته باشید که در صورت استفاده از این گزینه باید تنظیمات [SMTP](#smtp) را نیز انجام دهید.
9090

9191
### reply-notifications
9292

@@ -350,9 +350,9 @@ password =
350350

351351
در نهایت روند اعتبارسنجی به کلی تغییر یافت و از روش های جایگزین برای این مورد استفاده شد. از آنجایی که در نیکاس جهت استفاده از پنل مدیریت نیاز به تعریف حساب کاربری خاصی نداریم ، پس مسلما یک کلمه عبور ساده جهت احراز هویت کافی است. یکی از اولین راه ها استفاده از `SHA-256` خواهد بود که در سال های اخیر مشکلاتی رو نیز به همراه داشته :
352352

353-
- [CWE-327](https://cwe.mitre.org/data/definitions/327.html)
354-
- [CWE-328](https://cwe.mitre.org/data/definitions/328.html)
355-
- [CWE-916](https://cwe.mitre.org/data/definitions/916.html)
353+
- [CWE-327](https://cwe.mitre.org/data/definitions/327.html)
354+
- [CWE-328](https://cwe.mitre.org/data/definitions/328.html)
355+
- [CWE-916](https://cwe.mitre.org/data/definitions/916.html)
356356

357357
از این رو `SHA-256` به کلی کنار گذاشته شد و به سراغ [Argon2](https://en.wikipedia.org/wiki/Argon2) رفتیم. یک الگوریتم KDF که در امر رمزنگاری بسیار بهینه تر عمل می‎کند. این کتابخانه در نسخه [1.1.1](https://github.com/Nikas-Project/Server/releases/tag/1.1.1) به نیکاس اضافه شد و هم اکنون در دسترس است.
358358

src/getting-started/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
در این بخش به بررسی نیازمندی های سخت افزاری و نرم افزاری می پردازیم و نیکاس را نصب می کنیم :
44

5-
- [نیازمندی ها](requirements.md)
6-
- [نصب](install.md)
7-
- [اجرا](run.md)
5+
- [نیازمندی ها](requirements.md)
6+
- [نصب](install.md)
7+
- [اجرا](run.md)

src/getting-started/install.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
راه های مختلفی برای نصب نیکاس وجود داره :
44

5-
- [Python Package](#python-package)
6-
- [Source](#source)
7-
- [Docker](#docker)
8-
- [Kubernetes](#kubernetes)
5+
- [Python Package](#python-package)
6+
- [Source](#source)
7+
- [Docker](#docker)
8+
- [Kubernetes](#kubernetes)
99

1010
قبل از شروع به نصب ، ابتدا صفحه [پیش نیازها](requirements.md) را مطالعه کنید.
1111

@@ -93,8 +93,8 @@ docker run -d --rm --name nikas -p 127.0.0.1:8080:8080 -v /opt/nikas:/config -v
9393

9494
از آنجایی که برای سرور نیکاس ایمیج داکری در اختیار دارید ٬ استقرار آن روی کلاستر Kubernetes نیز به راحتی صورت می‎گیرد. قبل از شروع به دو نکته توجه داشته باشید:
9595

96-
- جهت اعمال کانفیگ های مختلف باید از ConfigMap استفاده کنید.
97-
- جهت ذخیره سازی دیتابیس باید از PersistentVolumeClaim استفاده کنید.
96+
- جهت اعمال کانفیگ های مختلف باید از ConfigMap استفاده کنید.
97+
- جهت ذخیره سازی دیتابیس باید از PersistentVolumeClaim استفاده کنید.
9898

9999
فایل Deployment نمونه در [مخزن نیکاس موجود است](https://github.com/Nikas-Project/Server/blob/master/kubernetes/deployment.yml). تنظیمات مورد نظر خودتان را اعمال کرده و نیکاس را مستقر کنید:
100100

@@ -104,21 +104,21 @@ kubectl apply -f nikas-deployment.yaml
104104

105105
تنظیماتی که باید اعمال کنید شامل این موارد است:
106106

107-
- `image` : نام و تگ ایمیج داکری نیکاس
108-
- `resources` : مشخصات منابع مورد نیاز برای اجرای نیکاس
109-
- `PersistentVolumeClaim` : حجم مورد نیاز برای ذخیره سازی دیتابیس
110-
- `ConfigMap` : کانفیگ های مورد نیاز برای اجرای نیکاس
111-
- `Route` : اگر از OpenShift استفاده می‎کنید ٬ این بخش را جهت معرفی دامنه خود تنظیم نمایید. در غیر اینصورت این بخش را حذف کرده و از Ingress Controller مناسب استفاده نمایید.
107+
- `image` : نام و تگ ایمیج داکری نیکاس
108+
- `resources` : مشخصات منابع مورد نیاز برای اجرای نیکاس
109+
- `PersistentVolumeClaim` : حجم مورد نیاز برای ذخیره سازی دیتابیس
110+
- `ConfigMap` : کانفیگ های مورد نیاز برای اجرای نیکاس
111+
- `Route` : اگر از OpenShift استفاده می‎کنید ٬ این بخش را جهت معرفی دامنه خود تنظیم نمایید. در غیر اینصورت این بخش را حذف کرده و از Ingress Controller مناسب استفاده نمایید.
112112

113113
### استقرار در کانتینر ابری ابرآروان
114114

115115
جهت استقرار نیکاس در کانتینر ابری ابرآروان ابتدا مراحل زیر را انجام دهید:
116116

117-
- ایجاد یک پروژه جدید ( یا استفاده از پروژه فعلی )
118-
- ایجاد یک کلید دسترسی با مراجعه به تنظیمات / کلیدهای API ( [راهنما](https://www.arvancloud.com/help/fa/article/360034038654--%da%86%da%af%d9%88%d9%86%d9%87-API-Key-%db%8c%d8%a7-%da%a9%d9%84%db%8c%d8%af-%d8%af%d8%b3%d8%aa%d8%b1%d8%b3%db%8c-%d8%a8%d8%b1%d9%86%d8%a7%d9%85%d9%87%e2%80%8c%d9%86%d9%88%db%8c%d8%b3%db%8c-%d8%a8%d8%b3%d8%a7%d8%b2%db%8c%d8%af%d8%9f) )
119-
- تعریف یک زیردامنه برای نیکاس ( مثلا `nikas.example.com` ) و ثبت رکورد CNAME با مقدار زیر:
120-
- `nikas.example.com``default-gateway.ir-thr-at1.arvan.run.`
121-
- دریافت [CLI](https://docs.arvancloud.com/fa/developer-tools/cli/) ابرآروان
117+
- ایجاد یک پروژه جدید ( یا استفاده از پروژه فعلی )
118+
- ایجاد یک کلید دسترسی با مراجعه به تنظیمات / کلیدهای API ( [راهنما](https://www.arvancloud.com/help/fa/article/360034038654--%da%86%da%af%d9%88%d9%86%d9%87-API-Key-%db%8c%d8%a7-%da%a9%d9%84%db%8c%d8%af-%d8%af%d8%b3%d8%aa%d8%b1%d8%b3%db%8c-%d8%a8%d8%b1%d9%86%d8%a7%d9%85%d9%87%e2%80%8c%d9%86%d9%88%db%8c%d8%b3%db%8c-%d8%a8%d8%b3%d8%a7%d8%b2%db%8c%d8%af%d8%9f) )
119+
- تعریف یک زیردامنه برای نیکاس ( مثلا `nikas.example.com` ) و ثبت رکورد CNAME با مقدار زیر:
120+
-`nikas.example.com``default-gateway.ir-thr-at1.arvan.run.`
121+
- دریافت [CLI](https://docs.arvancloud.com/fa/developer-tools/cli/) ابرآروان
122122

123123
پس از انجام مراحل بالا می‎توانید نیکاس را مستقر کنید:
124124

src/getting-started/requirements.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ sudo yum install python-setuptools python-virtualenv python-devel
3838

3939
نیازمندی های اصلی نیکاس :
4040

41-
- Python 3.7+ (+ devel headers)
42-
- SQLite 3.3.8 or later
41+
- Python 3.7+ (+ devel headers)
42+
- SQLite 3.3.8 or later
4343

4444
در صورتی که تمایل به کامپایل و اجرای نیکاس از سورس را دارید ، باید لیست زیر را نصب داشته باشید :
4545

46-
- [Make](https://www.gnu.org/software/make/)
47-
- C compiler
48-
- [NodeJS](https://nodejs.org/en/download/)
49-
- [NPM](https://npmjs.org/)
46+
- [Make](https://www.gnu.org/software/make/)
47+
- C compiler
48+
- [NodeJS](https://nodejs.org/en/download/)
49+
- [NPM](https://npmjs.org/)
5050

5151
> ❕ متاسفانه به دلیل برخی کتابخانه های استفاده شده در نیکاس امکان استفاده از NodeJS نسخه ۱۶ به بالا وجود ندارد. حتما از نسخه ۱۴ استفاده کنید.
5252

src/getting-started/run.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ password = secret_token
3333

3434
در اینجا چنین مواردی را تعریف کرده ایم :
3535

36-
- نام دیتابیس `example.db`
37-
- آدرس وب سایتی که نظرات در آن مدیریت می شوند ( وبلاگ شما ) : `https://arash-hatami.ir`
38-
- Host و Port مربوطه برای اجرای نیکاس : `localhost` - `1234`
39-
- پنل مدیریت فعال بوده و رمز ورود آن `secret_token` ( این مورد رمز عبور خام و اصلی نیست ، بعدا در موردش صحبت می کنیم )
36+
- نام دیتابیس `example.db`
37+
- آدرس وب سایتی که نظرات در آن مدیریت می شوند ( وبلاگ شما ) : `https://arash-hatami.ir`
38+
- Host و Port مربوطه برای اجرای نیکاس : `localhost` - `1234`
39+
- پنل مدیریت فعال بوده و رمز ورود آن `secret_token` ( این مورد رمز عبور خام و اصلی نیست ، بعدا در موردش صحبت می کنیم )
4040

4141
جهت مشاهده اطلاعات بیشتر در مورد تنظیم سرور نیکاس به این صفحه بروید : [تنظیمات سرور](../config/server.md)

src/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414

1515
در حال حاضر راه های زیادی برای رفع این مشکل وجود داره ولی با مسائل زیر مواجه خواهید شد :
1616

17-
- تحریم / فیلتر
18-
- عدم پشتیبانی از زبان فارسی
19-
- سنگین بودن کتابخانه
20-
- ...
17+
- تحریم / فیلتر
18+
- عدم پشتیبانی از زبان فارسی
19+
- سنگین بودن کتابخانه
20+
- ...
2121

2222
نیکاس اینجا است تا مشکلات وبلاگ ها و سایت های پارسی زبان رو حل کنه 😀

src/similar.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
نمونه های بسیار زیاد دیگری هم وجود داره. رایگان ، غیر رایگان ، متن باز و ...
2929
در نیکاس ویژگی های اصلی و مفید هرکدام از اون ها وجود داره :
3030

31-
- متن باز
32-
- سبک و کم حجم
33-
- طراحی UI مدرن تر
34-
- راحتی در استفاده
35-
- ...
31+
- متن باز
32+
- سبک و کم حجم
33+
- طراحی UI مدرن تر
34+
- راحتی در استفاده
35+
- ...

0 commit comments

Comments
 (0)