Teknik is a suite of services with attractive and functional interfaces. https://www.teknik.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 4.9KB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. # Teknik Web Services
  2. ---------------
  3. Teknik is a suite of services with attractive and functional interfaces.
  4. ## Features
  5. * File Upload w/ encryption
  6. * Pastebin
  7. * Blogs
  8. * Git Repositories
  9. * Podcasts
  10. * Easy to use API
  11. * Server Statistics
  12. * Flexible installation and configuration
  13. ## Screenshots
  14. [![File Upload Screenshot](https://cdn.teknik.io/default/img/screenshots/upload_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/upload_screenshot.PNG)
  15. [![Pastebin Screenshot](https://cdn.teknik.io/default/img/screenshots/paste_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/paste_screenshot.PNG)
  16. [![Blog Screenshot](https://cdn.teknik.io/default/img/screenshots/blog_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/blog_screenshot.PNG)
  17. [![Podcast Screenshot](https://cdn.teknik.io/default/img/screenshots/podcast_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/podcast_screenshot.PNG)
  18. [![Git Screenshot](https://cdn.teknik.io/default/img/screenshots/git_screenshot_thumb.png)](https://cdn.teknik.io/default/img/screenshots/git_screenshot.PNG)
  19. You can also see a live demo [here](https://www.teknik.io).
  20. ## Requirements
  21. In order to run Teknik on your server, you'll need:
  22. * IIS 7 with URL Rewrite module or Apache with mod_rewrite enabled (Requires conversion of web.config files)
  23. * PHP >= 5.4.14
  24. * MySQL
  25. * hMailServer (If running email as well)
  26. * Git >= 1.7.2
  27. * gitolite
  28. ## Installation
  29. * Clone the Teknik repository to your web root directory, or anywhere else you want to run Teknik from.
  30. ```
  31. cd /var/www
  32. git clone git://teknik.io/Teknik
  33. ```
  34. * Do not clone the development branch unless you want to run the latest code. It may be unstable.
  35. * Create a database and import DB.sql to create the required tables.
  36. * Rename and Edit Configs
  37. - Teknik Configuration
  38. * Rename the `includes/config.php.default` file to `includes/config.php`.
  39. * Open up the `includes/config.php` and configure the site installation.
  40. - Git Viewer Configuration
  41. * Rename the `git/config.ini-example` file to `git/config.ini`.
  42. * Open up the `git/config.ini` and configure the git viewer.
  43. - Server Stats Configuration
  44. * Rename the `stats/phpsysinfo.ini.new` file to `stats/phpsysinfo.ini`.
  45. * Open up the `stats/phpsysinfo.ini` and configure the server stats.
  46. - Mail Web Interface Configuration
  47. * Rename the `mail/config/mail.inc.php.dist` file to `mail/config/mail.inc.php`.
  48. * Rename the `mail/config/db.inc.php.dist` file to `mail/config/db.inc.php`.
  49. * Open up the `mail/config/mail.inc.php` and configure the mail web interface settings.
  50. * Open up the `mail/config/db.inc.php` and configure the mail database settings.
  51. * If you are running IIS
  52. - Add the following virtual directories to every page (home, upload, git, etc...):
  53. * templates `/var/www/Teknik/templates`
  54. * includes `/var/www/Teknik/includes`
  55. * If you are running Apache
  56. - Create an Alias for each of the following:
  57. * templates `/var/www/Teknik/templates`
  58. * includes `/var/www/Teknik/includes`
  59. * Create the cache folders and give read/write permissions to your web server user:
  60. ```
  61. cd /var/www/Teknik/templates/default
  62. mkdir cache
  63. chmod 777 cache
  64. cd /var/www/Teknik/git
  65. mkdir cache
  66. chmod 777 cache
  67. ```
  68. * Create a local repo of the gitolite-admin repository and give it read/write permissions to the PHP script user.
  69. - In order to clone the repo, you will need to be added as an administrator within gitolite. Refer to [Gitolite](http://gitolite.com/gitolite/) for information on how to set that up.
  70. ```
  71. cd /var/Repositories/
  72. git clone git@teknik.io:gitolite-admin
  73. chown -R www_user:GitGroup /var/Repositories/gitolite-admin/*
  74. chmod -R 750 /var/Repositories/gitolite-admin/*
  75. ```
  76. **That's it**, installation complete! If you're having problems, let us know through the [Contact](https://contact.teknik.io/) page.
  77. ## Authors and contributors
  78. * [Chris Woodward](https://www.teknik.io) (Creator, developer)
  79. * [dronedaddy](https://www.behance.net/dronedaddy) (Logo Designer)
  80. ## License
  81. [BSD 3-Clause license](http://opensource.org/licenses/BSD-3-Clause)
  82. ## Development
  83. 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)
  84. ## Contributing
  85. 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. But you can also dedicate yourself to refactoring the current codebase and improving what we already have. Any help you can give would be greatly appreciated!
  86. ## Further information
  87. 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! :)