-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdocs-page.html
457 lines (396 loc) · 18.8 KB
/
docs-page.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<!DOCTYPE html>
<html lang="en">
<head>
<title>TeleLiman - Use Port MYS over the phone</title>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="TeleLiman - Use Port MYS over the phone">
<meta name="author" content="TeleLiman">
<link rel="shortcut icon" href="favicon.ico">
<!-- Google Font -->
<link href="https://fonts.googleapis.com/css?family=Poppins:300,400,500,600,700&display=swap" rel="stylesheet">
<!-- FontAwesome JS-->
<script defer src="assets/fontawesome/js/all.min.js"></script>
<!-- Plugins CSS -->
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.2/styles/atom-one-dark.min.css">
<link rel="stylesheet" href="assets/plugins/simplelightbox/simple-lightbox.min.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/theme.css">
</head>
<body class="docs-page">
<header class="header fixed-top">
<div class="branding docs-branding">
<div class="container-fluid position-relative py-2">
<div class="docs-logo-wrapper">
<button id="docs-sidebar-toggler" class="docs-sidebar-toggler docs-sidebar-visible me-2 d-xl-none"
type="button">
<span></span>
<span></span>
<span></span>
</button>
<div class="site-logo"><a class="navbar-brand" href="index.html"><img class="logo-icon me-2"
src="assets/images/coderdocs-logo.svg" alt="logo"><span class="logo-text">Tele<span
class="text-alt">Liman</span></span></a></div>
</div>
<!--//docs-logo-wrapper-->
<div class="docs-top-utilities d-flex justify-content-end align-items-center">
<div class="top-search-box d-none d-lg-flex">
<form class="search-form">
<input type="text" placeholder="TeleLiman'da Ara..." name="search"
class="form-control search-input">
<button type="submit" class="btn search-btn" value="Ara"><i
class="fas fa-search"></i></button>
</form>
</div>
<ul class="social-list list-inline mx-md-3 mx-lg-5 mb-0 d-none d-lg-flex">
<li class="list-inline-item"><a href="https://github.com/TeleLiman"><i class="fab fa-github fa-fw"></i></a></li>
</ul>
<!--//social-list-->
<a href="https://github.com/TeleLiman/TelelimanExtension/raw/main/TeleLiman-0.0.1.lmne"
class="btn btn-primary d-none d-lg-flex">İndir</a>
</div>
<!--//docs-top-utilities-->
</div>
<!--//container-->
</div>
<!--//branding-->
</header>
<!--//header-->
<div class="docs-wrapper">
<div id="docs-sidebar" class="docs-sidebar">
<div class="top-search-box d-lg-none p-3">
<form class="search-form">
<input type="text" placeholder="Search the TeleLiman..." name="search"
class="form-control search-input">
<button type="submit" class="btn search-btn" value="Search"><i class="fas fa-search"></i></button>
</form>
</div>
<nav id="docs-nav" class="docs-nav navbar">
<ul class="section-items list-unstyled nav flex-column pb-3">
<li class="nav-item section-title"><a class="nav-link scrollto active" href="#section-1"><span
class="theme-icon-holder me-2"><i class="fas fa-map-signs"></i></span>Giriş</a>
</li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-1-1">Bu Uygulama Nedir?</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-1-2">Uygulamanın avantajları
nelerdir?</a></li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-2"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Kurulum</a>
</li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-2-1">Telegram Botunun Ayarlanması</a>
</li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-2-2">Otomatik kurulum</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-2-3">Manuel kurulum</a></li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-3"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Kullanım</a>
</li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-3-1">Fonksiyonlar</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-3-2">Çökme Raporu</a></li>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-4"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Geliştiriciler
İçin</a>
</li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-4-1">Dosya yapısı</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-4-2">Çalışma Mantığı</a></li>
<li class="nav-item"><a class="nav-link scrollto" href="#item-4-3">Helpers</a></li>
</ul>
<li class="nav-item section-title mt-3"><a class="nav-link scrollto" href="#section-5"><span
class="theme-icon-holder me-2"><i class="fas fa-arrow-down"></i></span>Gelecek Sürümler</a>
</li>
</ul>
</nav>
<!--//docs-nav-->
</div>
<!--//docs-sidebar-->
<div class="docs-content">
<div class="container">
<article class="docs-article" id="section-1">
<header class="docs-header">
<h1 class="docs-heading">Giriş <span class="docs-time">Son Güncelleme: 17.05.2022</span>
</h1>
<section class="docs-intro">
<p> Uygulama LimanMYS kullanıcılarının telefon üzerinden hızlı bir şekilde daha öncesinde
yapılandırılmış serverlarına hızlı ve basit bir erişim sağlayan PHP ve Python ile
yazılmış bir eklentidir.</p>
</section>
<h5>Helper.php</h5>
<p>
<div class="docs-code-block">
<pre class="shadow-lg rounded"><code class="json hljs"> print_r("Uygulamanın çalıştırılması kullanımı hakkında bilgiler verilecektir.")
</code></pre>
</div>
<!--//docs-code-block-->
</header>
<section class="docs-section" id="item-1-1">
<h2 class="section-heading">Bu uygulama nelere yardımcı olur?</h2>
<p>Sistem yöneticilerinin işlerini kolaylaştırmak amacıyla yazılmıştır. </p>
<h5>Uygulama:</h5>
<ol>
<li>Önceden eklentinin eklediği servislerde update, reboot, shutdown methodlarının uygulama
üzerinde çalışması</li>
<li>Eklenmiş olan servislerin start, stop ve status işlemlerinin yapılmasını sağlaması</li>
<li>Herhangi bir çökme durumunda sorunun anında Sistem Yöneticisine bildirilmesi
</li>
</ol>
<p>Odaklanılmıştır.</p>
<br><br><br>
<h5>Geliştirici Notu</h5>
<div class="callout-block callout-block-info">
<div class="content">
<h4 class="callout-title">
<span class="callout-icon-holder me-1">
<i class="fas fa-info-circle"></i>
</span>
<!--//icon-holder-->
Note
</h4>
<p>Uygulama hızlı bir şekilde geliştirildiğinden dolayı sorunların tespiti konusunda
daha fazla düşünülebilir. Geliştirilen dizayn yapısı hızlı bir şekilde
geliştirilmeye müsaittir.
</p>
</div>
<!--//content-->
</section>
<!--//section-->
<section class="docs-section" id="item-1-2">
<h2 class="section-heading">Uygulamanın avantajları nelerdir?</h2>
<p>Kullanılan sistemlerin telefon erişimi sayesinde hızlıca görüntülenebilmesi, plugin üzerinde
ufak değişikliklerle her ihtiyaca uygun bir bot tasarlanabilmesini sağlar.</p>
<h5 class="mt-5">Örnek vermemiz gerekirse:</h5>
<ol>
<li>Uygulama bir helper sayesinde kullanıcıdan gelen istekler doğrultusunda betikler
çalıştırır. Betiklerin oluşturulabilmesi ve bot üzerine eklenebilmesi oldukça basittir.
</li>
<li>Telegram üzerinden çıkış sağlandığından dolayı uygulama üzerine gönderilebilecek
istekler başka bir güvenlik üzerinden daha geçer bu sayede uygulamaya ekstra güvenlik
sağlar. (Güvenlik konusuna "Geliştiriciler için" kısmında daha detaylı değinilecektir.)
</li>
<li>Sunucuların bakımların kişilere TeleLiman uygulaması üzerinden rahatlıkla
dağıtılabilmesini
sağlar.
</li>
</ol>
</div>
<!--//gallery-->
</section>
<!--//section-->
</section>
</article>
<article class="docs-article" id="section-2">
<header class="docs-header">
<h1 class="docs-heading">Kurulum</h1>
<section class="docs-intro">
<p>Bu kısımda eklentinin nasıl doğru bir şekilde yapılandırılıp kurulabileceğine ayrıntılı
şekilde girilecektir.</p>
</section>
<!--//docs-intro-->
</header>
<section class="docs-section" id="item-2-1">
<h2 class="section-heading">Telegram Botunun oluşturulması</h2>
<ol>
<li>
Telegram üzerinden '@BotFather' botu bulunur. Bu bota /start komutu verilerek bot
kullanılmaya başlanır.
</li>
<li>
/newbot komutu kullanılır. İlk aşamada bota bir isim verilir. Bu isim kullanıcı adı değil
botun ismidir.
</li>
<li>
Sonrasında bota benzersiz bir kullanıcı adı seçilmelidir. Bota seçilen kullanıcı adı '*Bot'
veya '*_bot' yapısına uygun olarak belirlenmelidir. Örneğin 'test123a_bot' 'test123aBot'
gibi...
</li>
<li>
Sonrasında @BotFather bize http API token'ımızı verir. Bu token uygulamanın diğer
aşamalarında bize yardımcı olacaktır bu yüzden not almanız önerilir.
</li>
</ol>
</section>
<section class="docs-section" id="item-2-2">
<h2 class="section-heading">Otomatik kurulum</h2>
<ol>
<li>
<a href="https://teleliman.github.io/download/install.sh">install.sh</a> dosyası sunucu
üzerine indirilir ve çalıştırılır.
<div class="docs-code-block">
<pre class="shadow-lg rounded"><code class="json hljs"> wget https://teleliman.github.io/download/install.sh
./install.sh</code></pre>
</div>
</li>
<li>
Liman MYS arayüzü üzerine giriş yapılarak ilgili sunucuya ilgili eklenti eklenir. <a
href="https://docs.liman.dev/kullanim-kilavuzu/liman-kurulumu/eklenti-kurulumu-ve-guencellemeler">Liman
MYS eklenti kurulum dokumanı</a>
</li>
<li>
Yan panelden ilgili sunucu seçilerek sunucunun altındaki panelde bulunan telegram uygulaması
seçilir.
Gelen ekrandan telegram_token, telegram_username ve yönetilmek istenen sunucunun root
şifresi girilir.
</li>
<li>
Sonra yan panelde bulunan eklenti ismine tıklanır. Ekranda bulunan 'Konfigure et' butonuna
tıklanmasının ardından ilgili sunucu yeniden başlatılır.
</li>
</ol>
</section>
<!--//section-->
<section class="docs-section" id="item-2-3">
<h2 class="section-heading">Manuel Kurulum</h2>
<ol>
<li>
Sunucu üzerindeki bekleyen güncelleştirmeler yapılır.
<div class="docs-code-block">
<pre
class="shadow-lg rounded"><code class="json hljs"> sudo apt update & sudo apt upgrade -y</code></pre>
</li>
<li>
Gerekli uygulamaların kurulması
<div class="docs-code-block">
<pre class="shadow-lg rounded"><code class="json hljs"> sudo apt install python3, python3-pip, git, wget, python3-paramiko
pip3 install requests, json</code></pre>
</li>
<li>
Eklenti dosyalarının sunucu üzerine indirilmesi
<div class="docs-code-block">
<pre class="shadow-lg rounded"><code class="json hljs"> git clone https://github.com/TeleLiman/TelelimanExtension.git /liman/extensions
mv TelelimanExtension/ teleliman/
</code></pre>
</li>
<li>
Servis komutlarının girilmesi
<div class="docs-code-block">
<pre class="shadow-lg rounded"><code class="json hljs"> echo 'nohup python3 /liman/extensions/teleliman/scripts/main.py > /dev/null 2>&1 &' > /root/service.sh
wget -P /etc/systemd/system/ https://teleliman.github.io/download/teleliman.service
systemctl daemon-reload
systemctl enable teleliman.service
systemctl start teleliman.service</code></pre>
</li>
<li>
Liman MYS arayüzü üzerine giriş yapılarak ilgili sunucuya ilgili eklenti eklenir. <a
href="https://docs.liman.dev/kullanim-kilavuzu/liman-kurulumu/eklenti-kurulumu-ve-guencellemeler">Liman
MYS eklenti kurulum dokumanı</a>
</li>
<li>
Yan panelden ilgili sunucu seçilerek sunucunun altındaki panelde bulunan telegram uygulaması
seçilir.
Gelen ekrandan telegram_token, telegram_username ve yönetilmek istenen sunucunun root
şifresi girilir.
</li>
<li>
Sonra yan panelde bulunan eklenti ismine tıklanır. Ekranda bulunan 'Konfigure et' butonuna
tıklanmasının ardından ilgili sunucu yeniden başlatılır.
</li>
</ol>
</section>
</article>
<!--//docs-article-->
<article class="docs-article" id="section-3">
<header class="docs-header">
<h1 class="docs-heading">Kullanım</h1>
<section class="docs-intro">
<p>Bu kısımda ilgili servislerin nasıl kullanılabileceğine değinilmiştir. Servis yapısı gereği
geliştirilmeye açıktır. Aşağıda eklenen komutlar örnek olarak tasarlanmıştır</p>
</section>
<!--//docs-intro-->
</header>
<section class="docs-section" id="item-3-1">
<h2 class="section-heading">Fonksiyonlar</h2>
<p><b>/shutdown</b>: İlgili sunucunun kapatılmasını sağlar.</p>
<p><b>/reboot</b>: İlgili sunucunun yeniden başlatılmasını sağlar.</p>
<p><b>/update</b>: İlgili sunucunun güncellenmesini sağlar.</p>
<p><b>/startservice</b>: İlgili sunucudaki bir servisinin başlatılmasını sağlar.</p>
<p><b>/stopservice</b>: İlgili sunucudaki bir servisinin kapatılmasını sağlar.</p>
<p><b>/statusservice</b>: İlgili sunucudaki bir servisinin durumunun sorgulanmasını sağlar.</p>
<p><b>/uname</b>: İlgili sunucunun uname fonksiyonun çalıştırılmasını sağlar.</p>
</section>
<!--//section-->
<section class="docs-section" id="item-3-2">
<h2 class="section-heading">Çökme Raporu</h2>
<p>Herhangi bir sunucunda çökme durumu oluştuğunda uygulama otomatik olarak app üzerinden mesaj
gönderir.</p>
</section>
</article>
<!--//docs-article-->
<article class="docs-article" id="section-4">
<header class="docs-header">
<h1 class="docs-heading">Geliştiriciler İçin</h1>
<section class="docs-intro">
<p>Bu kısımda uygulamanın yapısı anlatılacaktır. Yazılan eklentiyi manipüle ederek kendi
fonksiyonlarınızı ekleyebilir istekleriniz doğrultusunda geliştirebilirsiniz.</p>
</section>
</header>
<section class="docs-section" id="item-4-1">
<h2 class="section-heading">Dosya Yapısı</h2>
<p>Liman MYS'nin belirttiği dosya yapısı aktif olarak kullanılmaktadır. <a
href="https://docs.liman.dev/eklenti-gelistirme/genel-bilgiler/dizin-yapisi">LimanMYS dosya
yapısı</a> Artı olarak /root/service.sh isminde başlangıç servisimiz mevcuttur.</p>
</section>
<!--//section-->
<section class="docs-section" id="item-4-2">
<h2 class="section-heading">Çalışma Mantığı</h2>
<p>Liman MYS üzerinden server() ve extensionDb() ile Liman MYS üzerinden alınan bilgiler
scripts/settings.json dosyası içine işlenir. scripts/main.py dosyası json içindeki verileri
kullanarak uzak sunuculara ssh yardımıyla bağlanır. Telegramdan gelen istekleri bu uzak sunucu
üzerinde gerçekleştirir.</p>
</section>
<!--//section-->
<section class="docs-section" id="item-4-3">
<h2 class="section-heading">Helpers</h2>
<p>
<ol>
<li>
Telegram üzerinde bulunan sendMessage() fonksiyonu, helpers içine eklenmiş ve böylece tüm
uygulama çıktıları mesaj iletebilme özelliğine sahip olmuştur (Bkz. scripts/Helpers.py)
</li>
<li>
Telegram üzerinde bulunan getUpdates() fonksiyonu, helpers içine eklenmiş ve böylece tüm
uygulama telegram üzerinden veri okuma özelliğine sahip olmuştur (Bkz. scripts/Helpers.py)
</li>
</ol>
</p>
</section>
</section>
<!--//section-->
</article>
<!--//docs-article-->
<article class="docs-article" id="section-5">
<header class="docs-header">
<h1 class="docs-heading">Gelecek Sürümler</h1>
<section class="docs-intro">
<p>Bu uygulama Havelsan Express Liman MYS Fikir Yarışması süresince geliştirilmiştir. Liman MYS
Core'a herhangi bir müdahale edilmeden tasarlanmıştır. Aşağıda geliştirilebilecek uygulamayı
daha ileriye taşıyacak fikirler developerlar ve juri için yazılmıştır.</p>
<p>
<ol>
<li><b>İki adımlı kimlik doğrulama (2fa)</b>: Uygulamayı ilk defa kurduğumuzda en çok
ilgimizi çeken uygulama üzerinde herhangi bir authentication faktörünün bulunmamasıydı.
Core'a müdahale edemediğimizden dolayı herhangi bir authentication eklemedik. </li>
<li><b>Kullanıcı Engelleme</b>: İçerde zararlı bir kullanıcı tespit edildiğinde otomatik olarak sistem tarafından banlanır.</li>
<li><b>Liman MYS Sürüm Kontroli</b>: Liman MYS üzerinde sürüm değişikliği olduğunda Telegram üzerinden sunucu yöneticisine izin verilebilir. Core müdehalesi yasak olduğundan ve uygulama bize böyle bir arayüz sunmadığından gerçekleştirilemedi.</li>
<li><b>Tek Bot Çoklu Sunucu</b>: Her sunucu için farklı bot oluşturmak yerine işlem yapılacak sunucu seçilerek işlem yaptırılabilinir.</li>
<li><b>Whitelist İp Bloğuna Ekleme</b>: İstenirse sisteme yanlızca belirli iplerden giriş sağlanabilir. Eğer yeni bir ip adresi eklenecekse bu işlem TeleLiman üzerinde yürütülebilir.</li>
<li><b>Pardus Liman Edition</b>: Liman kurulu sunucularda başka hiçbir işlem yapılmayacağı varsayıldığından limanın yüklü olarak geldiği bir .iso paketi hazırlanabilir.</li>
</ol>
</p>
</section>
<!--//docs-intro-->
</header>
</div>
</div>
</div>
<!--//docs-wrapper-->
<!-- Javascript -->
<script src="assets/plugins/popper.min.js"></script>
<script src="assets/plugins/bootstrap/js/bootstrap.min.js"></script>
<!-- Page Specific JS -->
<script src="assets/plugins/smoothscroll.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.8/highlight.min.js"></script>
<script src="assets/js/highlight-custom.js"></script>
<script src="assets/plugins/simplelightbox/simple-lightbox.min.js"></script>
<script src="assets/plugins/gumshoe/gumshoe.polyfills.min.js"></script>
<script src="assets/js/docs.js"></script>
</body>
</html>