Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jeeva Kandasamy <jkandasa@gmail.com>
- Loading branch information
0 parents
commit 2be64f2
Showing
20 changed files
with
644 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "themes/docsy"] | ||
path = themes/docsy | ||
url = https://github.com/google/docsy.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: "{{ replace .Name "-" " " | title }}" | ||
date: {{ .Date }} | ||
draft: true | ||
--- | ||
|
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
/* | ||
Add styles or override variables from the theme here. | ||
*/ | ||
|
||
$primary: #212427; | ||
$secondary: #06c; | ||
|
||
// $enable-gradients: false; | ||
// $enable-rounded: false; | ||
// $enable-shadows: false; | ||
|
||
// remove text logo | ||
.navbar-brand { | ||
.text-uppercase { | ||
display: none; | ||
} | ||
} | ||
|
||
// logo style override | ||
.navbar-logo { | ||
svg { | ||
margin: 0 10px; | ||
height: 38px !important; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
baseURL = "/" | ||
title = "MyController.org: The OpenSource Controller" | ||
enableRobotsTXT = true | ||
|
||
# Hugo allows theme composition (and inheritance). The precedence is from left to right. | ||
theme = ["docsy"] | ||
|
||
# Will give values to .Lastmod etc. | ||
# enableGitInfo = true | ||
|
||
# Language settings | ||
contentDir = "content/en" | ||
defaultContentLanguage = "en" | ||
defaultContentLanguageInSubdir = false | ||
# Useful when translating. | ||
enableMissingTranslationPlaceholders = true | ||
|
||
disableKinds = ["taxonomy", "taxonomyTerm"] | ||
|
||
# Highlighting config | ||
pygmentsCodeFences = true | ||
pygmentsUseClasses = false | ||
# Use the new Chroma Go highlighter in Hugo. | ||
pygmentsUseClassic = false | ||
#pygmentsOptions = "linenos=table" | ||
# See https://help.farbox.com/pygments.html | ||
pygmentsStyle = "tango" | ||
|
||
# Configure how URLs look like per section. | ||
[permalinks] | ||
blog = "/:section/:year/:month/:day/:slug/" | ||
|
||
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday | ||
[blackfriday] | ||
plainIDAnchors = true | ||
hrefTargetBlank = true | ||
angledQuotes = false | ||
latexDashes = true | ||
|
||
# Image processing configuration. | ||
[imaging] | ||
resampleFilter = "CatmullRom" | ||
quality = 75 | ||
anchor = "smart" | ||
|
||
[services] | ||
[services.googleAnalytics] | ||
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. | ||
id = "UA-00000000-0" | ||
|
||
# Language configuration | ||
|
||
[languages] | ||
[languages.en] | ||
title = "MyController.org: The OpenSource Controller" | ||
description = "The OpenSource Controller" | ||
languageName ="English" | ||
# Weight used for sorting. | ||
weight = 1 | ||
|
||
[languages.ta] | ||
title = "MyController.org: The OpenSource Controller" | ||
description = "The OpenSource Controller" | ||
languageName ="தமிழ்" | ||
contentDir = "content/ta" | ||
#time_format_default = "01.02.2006" | ||
#time_format_blog = "01.02.2006" | ||
|
||
[markup] | ||
[markup.goldmark] | ||
[markup.goldmark.renderer] | ||
unsafe = true | ||
[markup.highlight] | ||
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html | ||
style = "tango" | ||
# Uncomment if you want your chosen highlight style used for code blocks without a specified language | ||
# guessSyntax = "true" | ||
|
||
# Everything below this are Site Params | ||
|
||
# Comment out if you don't want the "print entire section" link enabled. | ||
[outputs] | ||
section = ["HTML", "print"] | ||
|
||
[params] | ||
copyright = "The MyController.org Authors." | ||
# privacy_policy = "https://policies.google.com/privacy" | ||
|
||
# First one is picked as the Twitter card image if not set on page. | ||
# images = ["images/project-illustration.png"] | ||
|
||
# Menu title if your navbar has a versions selector to access old versions of your site. | ||
# This menu appears only if you have at least one [params.versions] set. | ||
version_menu = "Releases" | ||
|
||
# Flag used in the "version-banner" partial to decide whether to display a | ||
# banner on every page indicating that this is an archived version of the docs. | ||
# Set this flag to "true" if you want to display the banner. | ||
archived_version = false | ||
|
||
# The version number for the version of the docs represented in this doc set. | ||
# Used in the "version-banner" partial to display a version number for the | ||
# current doc set. | ||
version = "0.0" | ||
|
||
# A link to latest version of the docs. Used in the "version-banner" partial to | ||
# point people to the main doc site. | ||
url_latest_version = "https://example.com" | ||
|
||
# Repository configuration (URLs for in-page links to opening issues and suggesting changes) | ||
github_repo = "https://github.com/mycontroller-org" | ||
# An optional link to a related project repo. For example, the sibling repository where your product code lives. | ||
github_project_repo = "https://github.com/mycontroller-org" | ||
|
||
# Specify a value here if your content directory is not in your repo's root directory | ||
# github_subdir = "" | ||
|
||
# Uncomment this if you have a newer GitHub repo with "main" as the default branch, | ||
# or specify a new value if you want to reference another branch in your GitHub links | ||
# github_branch= "main" | ||
|
||
# Google Custom Search Engine ID. Remove or comment out to disable search. | ||
# gcs_engine_id = "d72aa9b2712488cc3" | ||
|
||
# Enable Algolia DocSearch | ||
algolia_docsearch = false | ||
|
||
# Enable Lunr.js offline search | ||
offlineSearch = false | ||
|
||
# Enable syntax highlighting and copy buttons on code blocks with Prism | ||
prism_syntax_highlighting = false | ||
|
||
# User interface configuration | ||
[params.ui] | ||
# Enable to show the side bar menu in its compact state. | ||
sidebar_menu_compact = false | ||
# Set to true to disable breadcrumb navigation. | ||
breadcrumb_disable = false | ||
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) | ||
sidebar_search_disable = false | ||
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar | ||
navbar_logo = true | ||
# Set to true to disable the About link in the site footer | ||
footer_about_disable = false | ||
|
||
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. | ||
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. | ||
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, | ||
# add "hide_feedback: true" to the page's front matter. | ||
[params.ui.feedback] | ||
enable = false | ||
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). | ||
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.' | ||
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.' | ||
|
||
# Adds a reading time to the top of each doc. | ||
# If you want this feature, but occasionally need to remove the Reading time from a single page, | ||
# add "hide_readingtime: true" to the page's front matter | ||
[params.ui.readingtime] | ||
enable = false | ||
|
||
[params.links] | ||
# End user relevant links. These will show up on left side of footer and in the community page if you have one. | ||
[[params.links.user]] | ||
name ="Twitter" | ||
url = "https://twitter.com/mycontrollerorg" | ||
icon = "fab fa-twitter" | ||
desc = "Follow us on Twitter to get the latest news!" | ||
|
||
# Developer relevant links. These will show up on right side of footer and in the community page if you have one. | ||
[[params.links.developer]] | ||
name = "GitHub" | ||
url = "https://github.com/mycontroller-org" | ||
icon = "fab fa-github" | ||
desc = "Development takes place here!" | ||
|
||
[menu] | ||
[[menu.main]] | ||
name = "MyController 1.x" | ||
url = "https://mycontroller.org" | ||
weight = 1 | ||
|
||
[[menu.main]] | ||
name = "Forum" | ||
url = "https://forum.mycontroller.org" | ||
weight = 2 | ||
|
||
[[menu.main]] | ||
identifier = "github" | ||
name = "GitHub" | ||
pre = "<i class='fa fa-heart'></i>" | ||
url = "https://github.com/mycontroller-org" | ||
weight = 3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
+++ | ||
title = "MyController.org" | ||
linkTitle = "MyController.org" | ||
+++ | ||
|
||
{{< blocks/cover title="Welcome to MyController.org - The Open Source Controller" image_anchor="top" height="full" color="gray" >}} | ||
<div class="mx-auto"> | ||
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}"> | ||
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i> | ||
</a> | ||
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://demo-v2.mycontroller.org/"> | ||
Demo <i class="fas fa-laptop ml-2"></i> | ||
</a> | ||
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="/docs/getting-started/"> | ||
Install <i class="fas fa-download ml-2 "></i> | ||
</a> | ||
<p class="lead mt-5">A Complete Private end to end IoT Solution and super lightweight!</p> | ||
{{< blocks/link-down color="info" >}} | ||
</div> | ||
{{< /blocks/cover >}} | ||
|
||
|
||
{{% blocks/lead color="primary" %}} | ||
MyController.org is an IoT automation controller for home, office or any place. | ||
|
||
MyController.org is designed to run with limited resources. It can run on the first generation Raspberry PI. | ||
{{% /blocks/lead %}} | ||
|
||
|
||
{{< blocks/section color="white" >}} | ||
{{% blocks/feature icon="far fa-box" title="Download **from Quay.io**" %}} | ||
Get the [container images](https://quay.io/organization/mycontroller-org) | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="/docs/" %}} | ||
We do a [Pull Request](https://github.com/mycontroller-org/backend/pulls) contributions workflow on **GitHub**. New users are always welcome! | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/mycontrollerorg" %}} | ||
For announcement of latest features etc. | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{< /blocks/section >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: "MyController Blog" | ||
linkTitle: "Blog" | ||
menu: | ||
main: | ||
weight: 30 | ||
--- | ||
|
||
TBD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: "Documentation" | ||
linkTitle: "Documentation" | ||
weight: 20 | ||
menu: | ||
main: | ||
weight: 20 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: "Advanced Install" | ||
linkTitle: "Advanced Install" | ||
weight: 4 | ||
--- | ||
|
||
TBD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: "Getting Started" | ||
linkTitle: "Getting Started" | ||
weight: 2 | ||
--- | ||
|
||
## Prerequisites | ||
For now the installation bundle available only in the container image form. | ||
So it is mandatory to run it on any container orchestration setup. | ||
|
||
### Hardware Requirements | ||
* Disk Space: ~100 MiB | ||
* Memory / RAM: ~100 MiB | ||
|
||
### Software Requirements | ||
* Docker or any container orchestration | ||
* InfluxDB - for metrics data | ||
* Optional | ||
* MongoDB - for storage data | ||
|
||
In this document we are focusing installation on a docker setup. | ||
|
||
### Dependencies Installation | ||
* [Docker](/docs/getting-started/install-docker/) | ||
* [InfluxDB](/docs/getting-started/install-influxdb/) | ||
* [natsio Bus](/docs/getting-started/install-natsio/) | ||
* [Mosquitto MQTT Broker](/docs/getting-started/install-mosquitto/) | ||
|
||
### Install MyController.org | ||
|
||
* [Quick Install](/docs/quick-install/) | ||
* [Advanced Install](/docs/advanced-install/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: "Install Docker" | ||
linkTitle: "Install Docker" | ||
weight: 1 | ||
--- | ||
|
||
Docker can be installed in different way. Here it is explained to install it on Raspberry PI with Raspbian OS | ||
|
||
Follow the steps below to install docker on your Raspberry PI | ||
|
||
``` | ||
# copy the installation script | ||
curl -fsSL https://get.docker.com -o get-docker.sh | ||
# execute the script | ||
sudo sh get-docker.sh | ||
# enable the docker daemon | ||
sudo systemctl enable docker.service | ||
# start the docker daemon | ||
sudo systemctl start docker.service | ||
# check the docker daemon is active | ||
sudo systemctl is-active docker.service | ||
``` | ||
|
||
|
||
* Optional steps - If you plan to play docker command on user | ||
``` | ||
# add a non-root user to the docker group | ||
# here the "pi" is a user | ||
sudo usermod -aG docker pi | ||
``` |
Oops, something went wrong.