Teknikode 4 years ago
parent
commit
44efa4172f
4 changed files with 29 additions and 19 deletions
  1. 9
    0
      .editorconfig
  2. 14
    15
      README.md
  3. 1
    1
      Teknik/Areas/Help/Views/Help/Git.cshtml
  4. 5
    3
      Teknik/Areas/Help/Views/Help/Index.cshtml

+ 9
- 0
.editorconfig View File

@@ -0,0 +1,9 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true

+ 14
- 15
README.md View File

@@ -5,7 +5,7 @@ Teknik is a suite of services with attractive and functional interfaces.
## Features
* File Upload w/ encryption
* Pastebin
* Url Shortening
* URL Shortening
* Blogs
* Git Repositories
* Podcasts
@@ -17,27 +17,27 @@ You can see a live demo [here](https://www.teknik.io).
## Requirements
In order to run Teknik on your server, you'll need:

* IIS 7+ with URL Rewrite module or Apache with mod_rewrite enabled (Requires conversion of web.config files)
* IIS 7+ with URL Rewrite module or Apache with `mod_rewrite` enabled (Requires conversion of `web.config` files)
* ASP.NET MVC 5
* .NET Framework 4.5.2
* MS SQL Server
* hMailServer (If running email as well)
* Web Mail Client (If you would like to have webmail)
* Gogs Service (If you want to have git integration)
* Gogs Service (If you want to have Git integration)

## Installation
* Clone the Teknik repository to your web root directory, or anywhere else you want to run Teknik from.
* Clone the Teknik repository to your web root directory, or anywhere else you want to run Teknik from

```
```nohighlight
cd /var/www
git clone https://git.teknik.io/Teknikode/Teknik
```

* Open the Teknik.sln file to build the project.
* Copy the build files to your wwwroot directory.
* Create a **ConnectionStrings.config** file in the **App_Data** directory and fill it with the following template and put in your sql server conenction details
* Open the `Teknik.sln` file to build the project
* Copy the build files to your `wwwroot` directory
* Create a `ConnectionStrings.config` file in the `App_Data` directory and fill it with the following template and put in your SQL server connection details

```
```nohighlight
<connectionStrings>
<add name="TeknikEntities"
providerName="System.Data.SqlClient"
@@ -45,23 +45,22 @@ git clone https://git.teknik.io/Teknikode/Teknik
</connectionStrings>
```

* After first run, a **Config.json** file will be created in the **App_Data** directory. This will need to be edited with your configuration options.
* After the first run, a `Config.json` file will be created in the `App_Data` directory. This will need to be edited with your configuration options.

**That's it**, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.
That's it, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.

## Authors and contributors
* [Chris Woodward](https://www.teknik.io) (Creator, developer)
* [Chris Woodward](https://www.teknik.io) (Creator, Developer)
* [dronedaddy](https://www.behance.net/dronedaddy) (Logo Designer)

## License
[BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause)

## Development
You can view Teknik's [Development Branch](https://dev.teknik.io/) to see the current new features. (It may not work, as it is a development branch)
You can view Teknik's [Development Branch](https://dev.teknik.io/) to see the current new features (It may not work, as it is a development branch).

## Contributing
If you are a developer, we need your help. Teknik is a young project and we have lot's of stuff to do. Some developers are contributing with new features, others with bug fixes. Any help you can give would be greatly appreciated!
If you are a developer, we need your help. Teknik is a young project and we have lots of stuff to do. Some developers are contributing with new features, others with bug fixes. Any help you can give would be greatly appreciated!

## Further information
If you want to know more about the features of Teknik, check the [Help](https://help.teknik.io/) page. Also, if you're having problems with Teknik, let us know through the [Contact](https://contact.teknik.io/) page. Don't forget to give feedback and suggest new features! :)


+ 1
- 1
Teknik/Areas/Help/Views/Help/Git.cshtml View File

@@ -6,7 +6,7 @@
<hr>
<h3>Authorization</h3>
<p>
To login into your git account, you will initially need to initially use your teknik email address to login using the web interface. Once you have done so at least once, you can from then on use your teknik username.
To login into your Git account, you will initially need to use your Teknik email address to login using the web interface. Once you have done so at least once, you can from then on use your Teknik username.
</p>
</div>
</div>

+ 5
- 3
Teknik/Areas/Help/Views/Help/Index.cshtml View File

@@ -18,19 +18,21 @@
<h3 class="text-center">Help Topics</h3>
<dl class="dl-horizontal">
<dt><a href="@Url.SubRouteUrl("help", "Help.API")">API</a></dt>
<dd>Open API available to interact with the difference services.</dd>
<dd>Open API available to interact with the different services.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Blog")">Blogging</a></dt>
<dd>Blogging platform available to the users and visible to the public.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Git")">Git Repositories</a></dt>
<dd>Unlimited public and private git repositories.</dd>
<dd>Unlimited public and private Git repositories.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.IRC")">IRC Network</a></dt>
<dd>IRC network that uses the Teknik userbase for nickname authentication.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Mail")">Mail Server</a></dt>
<dd>Mail service with IMAP and POP3 support with <b>1 GB</b> storage.</dd>
<dd>Mail service featuring IMAP and POP3 support with <b>1 GB</b> storage.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Markdown")">Markdown</a></dt>
<dd>Markdown syntax used throughout the site.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Mumble")">Mumble Chat Server</a></dt>
<dd>The public Mumble server and configuration settings needed.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.RSS")">RSS Feeds</a></dt>
<dd>Built-in RSS support for content updates.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Tools")">Tools</a></dt>
<dd>Internal and 3rd Party Tools for interfacing with our services.</dd>
<dt><a href="@Url.SubRouteUrl("help", "Help.Upload")">Uploads</a></dt>

Loading…
Cancel
Save