| Both sides previous revisionPrevious revisionNext revision | Previous revision | 
| information:projects [2016/12/19 21:31]  –  KerryCZE | information:projects [2025/03/30 18:04] (current)  – Remove deprecated haveapi repos aither | 
|---|
| ====== Projects of the VpsFree.cz Association ====== | ====== Projects of the vpsFree.cz Association ====== | 
| All projects are available in the form of Git repositories on | Our projects are available on [[https://github.com/vpsfreecz|GitHub]], bugs and issues | 
| https://git.vpsfree.cz and mirrored on | can be reported there. | 
| [[https://github.com/vpsfreecz|GitHub]]. |  | 
|  |  | 
| In order to organize development, bug reports and idea collection, we have a |  | 
| [[https://redmine.vpsfree.cz|Redmine]], see |  | 
| [[information:Bugs_and_Ideas|where to report bugs and send ideas]]. |  | 
|  |  | 
| ===== vpsFree.cz ===== | ===== vpsFree.cz ===== | 
| ^ Repository               ^ Description                                          ^ | ^ Repository               ^ Description                                          ^ | 
| | [[https://github.com/vpsfreecz/web|web]]    | The www.vpsfree.cz website.   | | | [[https://github.com/vpsfreecz/web|web]]    | The www.vpsfree.org website.   | | 
| | [[https://github.com/vpsfreecz/vpsfree-client|vpsfree-client]] | A client for https://api.vpsfree.cz.| | | [[https://github.com/vpsfreecz/vpsf-status|vpsf-status]]    | https://status.vpsf.cz   | | 
| | [[https://github.com/vpsfreecz/build-vpsfree-templates|build-vpsfree-templates]] | Scripts used to generate templates of distributions.       | | | [[https://github.com/vpsfreecz/vpsfree-client|vpsfree-client]] | A client for https://api.vpsfree.cz. | | 
| | [[https://github.com/vpsfreecz/salt-configuration|salt-configuration]]      | Physical server configuration.                 | | | [[https://github.com/vpsfreecz/vpsfree-cz-configuration|vpsfree-cz-configuration]] | Configuration of vpsFree.cz infrastructure | | 
| | [[https://github.com/vpsfreecz/vpsfree-irc-bot|vpsfree-irc-bot]]        | An IRC bot on our channel.                       | | | [[https://github.com/vpsfreecz/confctl|confctl]]       | Nix deployment tool, used by [[https://github.com/vpsfreecz/vpsfree-cz-configuration|vpsfree-cz-configuration]] | | 
|  |  | 
| ===== HaveAPI ===== | ===== vpsAdminOS ===== | 
| HaveAPI is a framework used for the creation of | [[https://vpsadminos.org|vpsAdminOS]] is a Linux distribution based on | 
| [[https://github.com/vpsfreecz/haveapi/#what-is-a-self-describing-api|self-documenting | [[https://nixos.org|NixOS]] and [[https://github.com/cleverca22/not-os/|not-os]] | 
| RESTful APIs]], | serving as a host for container virtualisation. | 
| which was originally created for the vpsAdmin API. However, it is a separate project. |  | 
| Thanks to the ability of the API to self-document, generic clients that do not need to know anything about the API beforehand can be used to communicate with such an API. |  | 
|  |  | 
|  |  | 
| ^ Repository               ^ Description                                          ^ | ^ Repository ^ Description                                          ^ | 
| | [[https://github.com/vpsfreecz/haveapi|haveapi]]   | A framework for the implementation of API servers in Ruby. | | | [[https://github.com/vpsfreecz/vpsadminos|vpsadminos]]       | vpsAdminOS | | 
| | [[https://github.com/vpsfreecz/haveapi-client|haveapi-client]]     | A client library and CLI in Ruby.               | | | [[https://github.com/vpsfreecz/linux|linux]]                | Linux kernel used in vpsAdminOS | | 
| | [[https://github.com/vpsfreecz/haveapi-client-php|haveapi-client-php]] | A client library in PHP.                      | | | [[https://github.com/vpsfreecz/zfs|zfs]]                | ZFS used in vpsAdminOS | | 
| | [[https://github.com/vpsfreecz/haveapi-client-js|haveapi-client-js]]  | A client library in JavaScript.              | | | [[https://github.com/vpsfreecz/vpsadminos-org-configuration|vpsadminos-org-configuration]] | Configuration of vpsadminos.org | | 
| | [[https://github.com/vpsfreecz/haveapi-webui|haveapi-webui]]      | A generic web interface.                                   | |  | 
| | [[https://github.com/vpsfreecz/haveapi-fs|haveapi-fs]]         | A file system based on FUSE.             | |  | 
| | [[https://github.com/vpsfreecz/haveapi-dokuwiki|haveapi-dokuwifi]]   | Authentication plugin for DokuWiki.              | |  | 
|  |  | 
| ===== vpsAdmin ===== | ===== vpsAdmin ===== | 
| [[https://vpsadmin.vpsfree.cz|vpsAdmin]] is an interface used to manage physical | [[https://vpsadmin.vpsfree.cz|vpsAdmin]] is an interface used to manage physical | 
| servers as well as virtual servers and drive storages and other | servers as well as virtual servers and drive storages and other | 
| related things running on them. VpsAdmin was developed in order to meet the needs of the vpsFree.cz association and in the | related things running on them. vpsAdmin was developed in order to meet the needs of the vpsFree.cz association and in the | 
| future we would also like to see it running outside of our infrastructure. | future we would also like to see it running outside of our infrastructure. | 
|  |  | 
| ^ Repository          ^ Description                                                ^ URL                                       ^ | ^ Repository          ^ Description                                                ^ | 
| | [[https://github.com/vpsfreecz/vpsadmin-api|vpsadmin-api]]       | RESTful API based on HaveAPI, the framework used to create vpsAdmin.    | https://api.vpsfree.cz                    | | | [[https://github.com/vpsfreecz/vpsadmin|vpsadmin]]       | vpsAdmin main repository. | | 
| | [[https://github.com/vpsfreecz/vpsadmind|vpsadmind]]          | A daemon running on all physical servers in a cluster | | | | [[https://github.com/vpsfreecz/vpsfree-mail-templates|vpsfree-mail-templates]]       | Templates for e-mails sent by vpsAdmin | | 
| | [[https://github.com/vpsfreecz/vpsadmindctl|vpsadmindctl]]       | A CLI utility used to control vpsadmind.                    | | | | [[https://github.com/vpsfreecz/terraform-provider-vpsadmin|terraform-provider-vpsadmin]]       | Provider for [[https://terraform.io]] | | 
| | [[https://github.com/vpsfreecz/vpsadmin-webui|vpsadmin-webui]]     | A web interface for the API based on HaveAPI clients. | https://vpsadmin.vpsfree.cz               | | | [[https://github.com/vpsfreecz/vpsadmin-go-client|vpsadmin-go-client]]       | Client for the [[manuals:vps:api|API]] in Golang | | 
| | [[https://github.com/vpsfreecz/vpsadmin-client|vpsadmin-client]]    | haveapi-client adapted to the vpsAdmin API.         | | |  | 
| | [[https://github.com/vpsfreecz/vpsadmin-doc|vpsadmin-doc]]       | vpsAdmin documentation.                               | https://projects.vpsfree.cz/vpsadmin-doc/ | | ===== HaveAPI ===== | 
| | [[https://github.com/vpsfreecz/vpsadmin-download-mounter|vpsadmin-download-mounter]] | Enables downloading backups of all servers from one place. | | | HaveAPI is a framework used for the creation of | 
| | [[https://github.com/vpsfreecz/vpsadmin-console-router|vpsadmin-console-router]]   | A router between clients and the backend for a remote console.     | | | [[https://github.com/vpsfreecz/haveapi/#what-is-a-self-describing-api|self-documenting | 
| | [[https://github.com/vpsfreecz/vpsadmin-mail-templates|vpsadmin-mail-templates]]   | Auxiliary scripts used to generate and install email templates. | | | RESTful APIs]], | 
| | [[https://github.com/vpsfreecz/vpsadmin-project-manager|vpsadmin-project-manager]]  | Bulk management of all vpsAdmin repositories.                | | | which was originally created for the vpsAdmin API. However, it is a standalone project. | 
| | [[https://github.com/vpsfreecz/vpsadmin-vpsfree|vpsadmin-vpsfree]]   | A vpsAdmin configuration specific to vpsFree.cz.     | | | Thanks to the ability of the API to self-document, generic clients that do not need to | 
| | [[https://github.com/vpsfreecz/vpsadmininstall|vpsadmininstall]]    | An old vpsAdmin installer, currently not working.          | | | know anything about the API beforehand can be used to communicate with such an API. | 
|  |  | 
|  |  | 
|  | ^ Repository               ^ Description                                          ^ | 
|  | | [[https://github.com/vpsfreecz/haveapi|haveapi]]   | Server frameworks/clients. | | 
|  |  | 
| ===== Other ===== | ===== Other ===== | 
| ^ Repository             ^ Description                                          ^ | ^ Repository             ^ Description                                          ^ | 
| | [[https://github.com/vpsfreecz/spl|spl]]   | A fork of https://github.com/zfsonlinux/spl    | | | [[https://github.com/vpsfreecz/vpsfree-irc-bot|vpsfree-irc-bot]]        | An IRC bot on our channel.                       | | 
| | [[https://github.com/vpsfreecz/zfs|zfs]]   | A fork of https://github.com/zfsonlinux/zfs      | | | [[https://github.com/vpsfreecz/vpsfree-maintenance-tasks|vpsfree-maintenance-tasks]] | Reusable scripts for administrators. | | 
| | [[https://github.com/vpsfreecz/vzctl|vzctl]]   | A fork of vzctl supporting several distributions and a remote console. | |  | 
|  |  | 
|  |  | 
| ===== Hosted services ===== | ===== Hosted services ===== | 
| ^ Service             ^ Description                                                       ^ URL ^ | ^ Service             ^ Description                                                       ^ URL ^ | 
| | IRC bouncer        | See [[information:chat#bouncer]]                              | https://im.vpsfree.cz/znc/ | |  | 
| | Paste service      | Service for pasting code snippets or program outputs | https://paste.vpsfree.cz | | | Paste service      | Service for pasting code snippets or program outputs | https://paste.vpsfree.cz | | 
|  |  | 
| ===== How to contribute ====== |  | 
| You can either attach patches to requests in Redmine, or you can make a pull request |  | 
| on GitHub. |  | 
|  |  |