Browse Source

modified help structure

tags/v1.3
Teknikode 5 years ago
parent
commit
434b26e405
8 changed files with 807 additions and 817 deletions
  1. 672
    676
      api/help.php
  2. 36
    40
      git/help.php
  3. 21
    7
      help/index.php
  4. 11
    15
      help/irc.php
  5. 13
    21
      help/main.php
  6. 7
    11
      help/mumble.php
  7. 42
    46
      mail/help.php
  8. 5
    1
      templates/default/js/help.js

+ 672
- 676
api/help.php
File diff suppressed because it is too large
View File


+ 36
- 40
git/help.php View File

@@ -1,44 +1,40 @@
<div class="container">
<div class="row">
<div class="col-xs-10">
<div name="Git" data-unique="Git"></div>
<h2><b>Git</b></h2>
<hr>
<div name="GitRepositoryAccess" data-unique="GitRepositoryAccess"></div>
<h3>Git Repository Access</h3>
<div class="row">
<div name="Git" data-unique="Git"></div>
<h2><b>Git</b></h2>
<hr>
<div name="GitRepositoryAccess" data-unique="GitRepositoryAccess"></div>
<h3>Git Repository Access</h3>
<p>
Every user is given the option to add public keys to the authorised users list to access their git repositories, and also access the main Teknik repositories.
<br />
<br />
To add a public key, just login, click your username on the top navbar and click 'Profile'. This will bring you to your profile page where you can add your public key or edit your existing one.
<br />
<br />
<div class="bs-callout bs-callout-warning">
<div name="PublicKeyFormat" data-unique="PublicKeyFormat"></div>
<h4>Public Key Format</h4>
<p>
Every user is given the option to add public keys to the authorised users list to access their git repositories, and also access the main Teknik repositories.
<br />
<br />
To add a public key, just login, click your username on the top navbar and click 'Profile'. This will bring you to your profile page where you can add your public key or edit your existing one.
<br />
<br />
<div class="bs-callout bs-callout-warning">
<div name="PublicKeyFormat" data-unique="PublicKeyFormat"></div>
<h4>Public Key Format</h4>
<p>
The Public Key must be in the following format: <b>ssh-rsa [0-9A-Za-z/+]</b>
</p>
</div>
</p>
<h3>Creating a Git Repository</h3>
<p>
Once you have a public key added, you will have the ability to create a repo. To do so, you just need to clone the repo you want to create, and the repo will be created.
<br />
<br />
<code>~$git clone git@teknik.io:u/[username]/[repository_name]</code>
</p>
<h3>Viewing a user's git repositories</h3>
<p>
You can also view a list of the git repo's a user has by visiting: <code><?php echo get_page_url('git', $CONF); ?>/u/[username]/</code>
<br />
</p>
<h3>Examples</h3>
<p>
<b>Clone a Repo (Git Daemon):</b> <code>~$git clone git://teknik.io/u/[username]/[repository_name]</code>
<br />
<b>Clone a Repo (SSH):</b> <code>~$git clone git@teknik.io:u/[username]/[repository_name]</code>
The Public Key must be in the following format: <b>ssh-rsa [0-9A-Za-z/+]</b>
</p>
</div>
</div>
</p>
<h3>Creating a Git Repository</h3>
<p>
Once you have a public key added, you will have the ability to create a repo. To do so, you just need to clone the repo you want to create, and the repo will be created.
<br />
<br />
<code>~$git clone git@teknik.io:u/[username]/[repository_name]</code>
</p>
<h3>Viewing a user's git repositories</h3>
<p>
You can also view a list of the git repo's a user has by visiting: <code><?php echo get_page_url('git', $CONF); ?>/u/[username]/</code>
<br />
</p>
<h3>Examples</h3>
<p>
<b>Clone a Repo (Git Daemon):</b> <code>~$git clone git://teknik.io/u/[username]/[repository_name]</code>
<br />
<b>Clone a Repo (SSH):</b> <code>~$git clone git@teknik.io:u/[username]/[repository_name]</code>
</p>
</div>

+ 21
- 7
help/index.php View File

@@ -8,13 +8,27 @@
require_once('../includes/config.php');
include('../templates/'.$CONF['template'].'/header.php');
include('main.php');
include('../git/help.php');
include('../mail/help.php');
include('irc.php');
//include('../minecraft/help.php');
include('mumble.php');
include('../api/help.php');
?>
<div class="container">
<div class="row">
<div class="col-md-9">
<?php
include('main.php');
include('../git/help.php');
include('../mail/help.php');
include('irc.php');
//include('../minecraft/help.php');
include('mumble.php');
include('../api/help.php');
?>
</div>
<div class="col-md-3">
<div id="toc">
</div>
</div>
</div>
</div>
<?php
include('../templates/'.$CONF['template'].'/footer.php');
set_page_title("Teknik Help");

+ 11
- 15
help/irc.php View File

@@ -1,16 +1,12 @@
<div class="container">
<div class="row">
<div class="col-xs-10">
<h2><b>IRC</b></h2>
<hr>
<h3>IRC Server Info</h3>
<p>
You can connect to the Teknik IRC using any RFC compliant client by connecting to <b>irc.<?php echo $CONF['host']; ?></b> on port <b>6667</b>.
</p>
<h3>Channel Information</h3>
<p>
The main channel for Teknik support is located at #teknik.
</p>
</div>
</div>
<div class="row">
<h2><b>IRC</b></h2>
<hr>
<h3>IRC Server Info</h3>
<p>
You can connect to the Teknik IRC using any RFC compliant client by connecting to <b>irc.<?php echo $CONF['host']; ?></b> on port <b>6667</b>.
</p>
<h3>Channel Information</h3>
<p>
The main channel for Teknik support is located at #teknik.
</p>
</div>

+ 13
- 21
help/main.php View File

@@ -1,22 +1,14 @@
<div class="container">
<div class="row">
<div class="col-xs-10">
<h2>This page contains specific help information for all of our services.</h2>
<hr>
<h3>Important Links</h3>
<dl class="dl-horizontal">
<dt><a href="<?php echo get_page_url("transparency", $CONF); ?>" target="_blank">Site Transparency</a></dt>
<dd>All the site's transactions, statistics, and data effecting actions.</dd>
<dt><a href="<?php echo get_page_url("privacy", $CONF); ?>" target="_blank">Privacy Policy</a></dt>
<dd>Everything about how we handle your privacy.</dd>
<dt><a href="<?php echo get_page_url("stats", $CONF); ?>" target="_blank">Server Statistics</a></dt>
<dd>The current Server Hardware statistics that Teknik is running on.</dd>
</dl>
</div>
<div class="col-xs-2">
<div id="toc">
</div>
</div>
</div>
<div class="row">
<h2>This page contains specific help information for all of our services.</h2>
<hr>
<h3>Important Links</h3>
<dl class="dl-horizontal">
<dt><a href="<?php echo get_page_url("transparency", $CONF); ?>" target="_blank">Site Transparency</a></dt>
<dd>All the site's transactions, statistics, and data effecting actions.</dd>
<dt><a href="<?php echo get_page_url("privacy", $CONF); ?>" target="_blank">Privacy Policy</a></dt>
<dd>Everything about how we handle your privacy.</dd>
<dt><a href="<?php echo get_page_url("stats", $CONF); ?>" target="_blank">Server Statistics</a></dt>
<dd>The current Server Hardware statistics that Teknik is running on.</dd>
</dl>
</div>

+ 7
- 11
help/mumble.php View File

@@ -1,12 +1,8 @@
<div class="container">
<div class="row">
<div class="col-xs-10">
<h2><b>Mumble</b></h2>
<hr>
<h3>Mumble Server Info</h3>
<p>
You can connect to the Mumble server by connecting to <b>mumble.<?php echo $CONF['host']; ?></b> on port <b>64738</b>.
</p>
</div>
</div>
<div class="row">
<h2><b>Mumble</b></h2>
<hr>
<h3>Mumble Server Info</h3>
<p>
You can connect to the Mumble server by connecting to <b>mumble.<?php echo $CONF['host']; ?></b> on port <b>64738</b>.
</p>
</div>

+ 42
- 46
mail/help.php View File

@@ -1,50 +1,46 @@
<div class="container">
<div class="row">
<h2><b>Mail</b></h2>
<hr>
<h3>Mail Server Settings</h3>
<p>
At registration, each user is given an email address with <b>1 GB</b> of storage space.
You can either access your email via the <a href="<?php echo get_page_url("mail", $CONF); ?>" target="_blank">Web Client</a> or by using a client of your choosing with support for IMAP or POP3.
</p>
<div class="row">
<div class="col-xs-10">
<h2><b>Mail</b></h2>
<hr>
<h3>Mail Server Settings</h3>
<p>
At registration, each user is given an email address with <b>1 GB</b> of storage space.
You can either access your email via the <a href="<?php echo get_page_url("mail", $CONF); ?>" target="_blank">Web Client</a> or by using a client of your choosing with support for IMAP or POP3.
</p>
<div class="row">
<div class="col-sm-5">
<ul class="list-group">
<li class="list-group-item text-center"><h4>Outlook</h4></li>
<li class="list-group-item text-center">User Information</li>
<li class="list-group-item">Email Address:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item text-center">Server Information</li>
<li class="list-group-item">Incoming Server:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Outgoing Server:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item text-center">Logon Information</li>
<li class="list-group-item">Username:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Password:<div class="pull-right"><b>[password]</b></div></li>
<li class="list-group-item text-center">More Settings</li>
<li class="list-group-item">Requires Authentication:<div class="pull-right"><b>Both</b></div></li>
<li class="list-group-item">Incoming Server (IMAP):<div class="pull-right"><b>143 (993 SSL)</b></div></li>
<li class="list-group-item">Outgoing Server (SMTP):<div class="pull-right"><b>25 (465 SSL)</b></div></li>
</ul>
</div>
<div class="col-sm-5 col-sm-offset-2">
<ul class="list-group">
<li class="list-group-item text-center"><h4>Thunderbird</h4></li>
<li class="list-group-item text-center">Server Settings</li>
<li class="list-group-item">Server Name:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Port:<div class="pull-right"><b>143 (993 SSL)</b></div></li>
<li class="list-group-item">User Name:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Connection Security:<div class="pull-right"><b>None (SSL/TLS)</b></div></li>
<li class="list-group-item">Authentication method:<div class="pull-right"><b>Password</b></div></li>
<li class="list-group-item text-center">Outgoing Server (SMTP)</li>
<li class="list-group-item">Server Name:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Port:<div class="pull-right"><b>25 (465 SSL)</b></div></li>
<li class="list-group-item">User Name:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Connection Security:<div class="pull-right"><b>None (SSL/TLS)</b></div></li>
<li class="list-group-item">Authentication method:<div class="pull-right"><b>Password</b></div></li>
</ul>
</div>
</div>
<div class="col-sm-5">
<ul class="list-group">
<li class="list-group-item text-center"><h4>Outlook</h4></li>
<li class="list-group-item text-center">User Information</li>
<li class="list-group-item">Email Address:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item text-center">Server Information</li>
<li class="list-group-item">Incoming Server:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Outgoing Server:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item text-center">Logon Information</li>
<li class="list-group-item">Username:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Password:<div class="pull-right"><b>[password]</b></div></li>
<li class="list-group-item text-center">More Settings</li>
<li class="list-group-item">Requires Authentication:<div class="pull-right"><b>Both</b></div></li>
<li class="list-group-item">Incoming Server (IMAP):<div class="pull-right"><b>143 (993 SSL)</b></div></li>
<li class="list-group-item">Outgoing Server (SMTP):<div class="pull-right"><b>25 (465 SSL)</b></div></li>
</ul>
</div>
<div class="col-sm-5 col-sm-offset-2">
<ul class="list-group">
<li class="list-group-item text-center"><h4>Thunderbird</h4></li>
<li class="list-group-item text-center">Server Settings</li>
<li class="list-group-item">Server Name:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Port:<div class="pull-right"><b>143 (993 SSL)</b></div></li>
<li class="list-group-item">User Name:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Connection Security:<div class="pull-right"><b>None (SSL/TLS)</b></div></li>
<li class="list-group-item">Authentication method:<div class="pull-right"><b>Password</b></div></li>
<li class="list-group-item text-center">Outgoing Server (SMTP)</li>
<li class="list-group-item">Server Name:<div class="pull-right"><b>mail.<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Port:<div class="pull-right"><b>25 (465 SSL)</b></div></li>
<li class="list-group-item">User Name:<div class="pull-right"><b>[username]@<?php echo $CONF['host']; ?></b></div></li>
<li class="list-group-item">Connection Security:<div class="pull-right"><b>None (SSL/TLS)</b></div></li>
<li class="list-group-item">Authentication method:<div class="pull-right"><b>Password</b></div></li>
</ul>
</div>
</div>
</div>

+ 5
- 1
templates/default/js/help.js View File

@@ -1,3 +1,7 @@
$(function() {
var toc = $("#toc").tocify({ theme: "bootstrap3" });
var toc = $("#toc").tocify({
selectors: "h2,h3,h4,h5",
theme: "bootstrap3",
context: '.col-md-9'
}).data("toc-tocify");
});

Loading…
Cancel
Save