forked from eclipse-californium/californium
-
Notifications
You must be signed in to change notification settings - Fork 2
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: Kai Hudalla <[email protected]>
- Loading branch information
Kai Hudalla
committed
Nov 7, 2019
1 parent
2c16735
commit 4da2680
Showing
74 changed files
with
653 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 "syna-theme"] | ||
path = site/themes/syna | ||
url = https://github.com/okkur/syna |
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 @@ | ||
public/ |
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/syna"] | ||
path = themes/syna | ||
url = https://git.okkur.org/syna |
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,61 @@ | ||
# Californium Web Site | ||
|
||
This is the source code for generating the Californium website hosted at https://eclipse.org/californium. | ||
It uses Syna theme and Hugo with two simple pages, one for landing and one for the community page. | ||
|
||
## Prerequisites | ||
- [Install Git](https://git-scm.com/downloads). | ||
- [Install Go](https://golang.org/doc/install). | ||
- [Install Hugo](https://gohugo.io/getting-started/installing/). Depending on your system, this might require Scoop, Choclatey, or other software. | ||
|
||
## Installation | ||
|
||
Before you are able to build the website, you need to update its git submodules (Syna theme is added as a submodule). | ||
|
||
``` | ||
git submodule init | ||
git submodule update | ||
``` | ||
|
||
## Usage | ||
|
||
To start start the website run the following commands: | ||
|
||
**Development**: | ||
``` | ||
$ hugo server -D # This command starts the Hugo server and watches the site directory for changes. | ||
``` | ||
|
||
**Production**: | ||
``` | ||
$ hugo # This command generates the static website in the public/ directory. If you do not have a site, then it gives errors about missing layout files. | ||
``` | ||
|
||
> Prerequisites: Go, Hugo | ||
## Directory Structure | ||
|
||
We're using the standard directory structure using content pages. | ||
|
||
``` | ||
├─ content/ | ||
| └ _global/ # All global fragments are located in this directory | ||
| └ _index/ # Landing page is in this directory and it's url is changed to **/**. | ||
| └ community/ # Community page | ||
├ layouts/ # contains additional and overridden layout files | ||
├ static/ # Your static files are in this directory. | ||
├ themes/ # Hugo uses this directory as a default to look for themes. Syna theme is a git submodule available in this directory. | ||
├ .gitignore | ||
├ .gitmodules | ||
├ config.toml # Hugo config file containing general settings and menu configs. | ||
``` | ||
|
||
For storing images in the static directory, note that Syna fragments look for | ||
images in their own fragment directory, page directory and `static/images` | ||
directory. Read our [image fallthrough documentation](https://syna.okkur.org/docs/image-fallthrough/) for more info. | ||
|
||
Further details read our [full documentation](https://syna.okkur.org/docs). | ||
|
||
## First Steps | ||
|
||
Open index.md and type. The changes are visible almost immediately at http://localhost:1313/. |
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,126 @@ | ||
# Site settings | ||
baseurl = "californium/" | ||
languageCode = "en-us" | ||
title = "Eclipse Californium™" | ||
theme = "syna" | ||
enableGitInfo = true | ||
version = "0.15.2" | ||
|
||
# Google Analytics tracking | ||
googleAnalytics = "" | ||
|
||
[outputs] | ||
home = ["HTML", "JSON"] | ||
|
||
[frontmatter] | ||
date = ["date", "lastmod"] | ||
lastmod = ["lastmod", ":git", "date"] | ||
|
||
[params] | ||
name = "Eclipse Californium project" | ||
description = "A Java framework for implementing CoAP clients and servers" | ||
|
||
[params.style] | ||
#background = "secondary" | ||
|
||
# Theme customizations | ||
# Assets relative to 'static/' | ||
[params.custom] | ||
# favicon = "favicon.ico" | ||
# favicon_ico_sizes = "16x16 32x32" | ||
favicon_png = "images/logos/Cf_32.png" | ||
# favicon_svg = "favicon.svg" | ||
|
||
# Piwik tracking | ||
[params.analytics.piwik] | ||
#url = "" | ||
#id = "" | ||
#domain = "" # Track subdomains via "*.example.com" | ||
# Optional hash for integrity check | ||
#hash = "sha512-RfeD0pacGTqy9m7U6PgehQfS4cc7SIt+e+P+H5e848kEvB/RW84CUGO3O4O3LNbxjevym6KPUZ8muPsMrI8WIw==" | ||
|
||
# Optional, global disable switch for fontawesome related files | ||
# For custom fontawesome js files use the custom.js method | ||
[params.fontawesome] | ||
disabled = false | ||
pro = false | ||
|
||
[params.colors] | ||
primary = "#00838F" | ||
secondary = "#868e96" | ||
success = "#008f54" | ||
info = "#00c9dc" | ||
warning = "#fdf314" | ||
danger = "#dc1200" | ||
light = "#f8f9fa" | ||
dark = "#343a40" | ||
|
||
# main/prepend/postpend menus are displayed in nav fragment. | ||
# Keep an eye out for updates. These will be moved out to make navbar more | ||
# configurable. | ||
[[menu.main]] | ||
url = "/" | ||
name = "Home" | ||
weight = 10 | ||
|
||
[[menu.main]] | ||
url = "#getting-started" | ||
name = "Getting Started" | ||
weight = 20 | ||
|
||
[[menu.main]] | ||
url = "#community" | ||
name = "Community" | ||
weight = 30 | ||
|
||
[[menu.footer]] | ||
url = "https://www.eclipse.org/legal/privacy.php" | ||
name = "Privacy Policy" | ||
weight = 10 | ||
|
||
[[menu.footer]] | ||
url = "https://www.eclipse.org/legal/termsofuse.php" | ||
name = "Terms of Use" | ||
weight = 20 | ||
|
||
[[menu.footer]] | ||
url = "https://www.eclipse.org/legal/copyright.php" | ||
name = "Copyright Agent" | ||
weight = 30 | ||
|
||
[[menu.footer]] | ||
url = "https://www.eclipse.org/legal/" | ||
name = "Legal" | ||
weight = 40 | ||
|
||
[[menu.footer]] | ||
url = "https://www.eclipse.org/legal/epl-2.0/" | ||
name = "License" | ||
weight = 50 | ||
|
||
[[menu.footer]] | ||
url = "https://eclipse.org/security/" | ||
name = "Report a Vulnerability" | ||
weight = 60 | ||
|
||
#[[menu.copyright_footer]] | ||
# url = "/about" | ||
# name = "About Us" | ||
# weight = 10 | ||
|
||
#[[menu.copyright_footer]] | ||
# url = "#" | ||
# name = "Another Link" | ||
# weight = 30 | ||
|
||
#[[menu.footer_social]] | ||
# weight = 20 | ||
# name = "github" | ||
# pre = "fab fa-github" | ||
# url = "https://github.com/eclipse/californium" | ||
|
||
#[[menu.footer_social]] | ||
# weight = 30 | ||
# name = "linkedin" | ||
# pre = "fab fa-linkedin-in" | ||
# url = "#" |
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,13 @@ | ||
+++ | ||
fragment = "config" | ||
|
||
[[config]] | ||
type = "css" # Acceptable values are icon, meta, link, css, js. Default is empty. Would not add anything on empty. | ||
# block = true # If set to true, would inject the code to the <head> tag. Default is false | ||
resource = "https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css" | ||
|
||
[[config]] | ||
type = "js" | ||
block = true # put script tag at the end of <body> | ||
resource = "https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js" | ||
+++ |
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,10 @@ | ||
+++ | ||
fragment = "copyright" | ||
#disabled = true | ||
date = "2016-09-07" | ||
weight = 1250 | ||
#background = "" | ||
|
||
copyright = "" # default: Copyright $Year .Site.params.name | ||
attribution = true # enable attribution by setting it to true | ||
+++ |
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,16 @@ | ||
+++ | ||
fragment = "footer" | ||
#disabled = true | ||
date = "2016-09-07" | ||
weight = 1200 | ||
background = "light" | ||
menu_title = "Eclipse Legal" | ||
|
||
[asset] | ||
image = "EF_GRY-OR_svg.svg" | ||
# text = "Logo Subtext" | ||
url = "https://www.eclipse.org" | ||
|
||
[affiliation] | ||
image = "eclipse_incubation_vertical_png-02.png" | ||
+++ |
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 @@ | ||
+++ | ||
headless = true | ||
+++ |
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,18 @@ | ||
+++ | ||
fragment = "nav" | ||
#disabled = true | ||
date = "2019-10-29" | ||
weight = 0 | ||
#background = "" | ||
sticky = true | ||
|
||
[repo_button] | ||
url = "https://github.com/eclipse/californium" | ||
text = "Star" # default: "Star" | ||
icon = "fab fa-github" # defaults: "fab fa-github" | ||
|
||
# Branding options | ||
[asset] | ||
# image = "logos/Cf_96.png" | ||
text = "Eclipse Californium" | ||
+++ |
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,25 @@ | ||
+++ | ||
fragment = "item" | ||
#disabled = false | ||
date = "2019-10-29" | ||
weight = 125 | ||
background = "light" | ||
align = "right" | ||
|
||
title = "Actinium (Ac)" | ||
#subtitle= "" | ||
|
||
# Subtitle pre and post item | ||
#pre = "Awesome screenshot" | ||
#post = "Showcasing Syna" | ||
|
||
[asset] | ||
# image = "Ac_box_256.png" | ||
image = "logos/Ac_256.png" | ||
|
||
[[buttons]] | ||
text = "Repository" | ||
url = "https://github.com/eclipse/californium.actinium" | ||
+++ | ||
|
||
Actinium (Ac) is the app-server for Californium to realize IoT mashups! Your JavaScript apps become available as RESTful resources and can directly talk to IoT devices using our CoapRequest object API. |
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 @@ | ||
+++ | ||
fragment = "items" | ||
weight = 150 | ||
title = "Get in Touch" | ||
subtitle = "Wanna tell us what you think about Californium? What we can improve? Which feature is missing? Or just discuss architectural issues?" | ||
background = "dark" | ||
+++ | ||
|
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,12 @@ | ||
+++ | ||
title = "Mailing List" | ||
weight = 20 | ||
|
||
[asset] | ||
icon = "fas fa-envelope-square" | ||
url = "https://accounts.eclipse.org/mailing-list/cf-dev" | ||
+++ | ||
|
||
This is the place where we announce new releases and discuss architectural issues of greater impact. | ||
|
||
However, questions and problems should be raised using a GitHug issue. |
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,12 @@ | ||
+++ | ||
title = "Report an Issue" | ||
weight = 10 | ||
|
||
[asset] | ||
icon = "fab fa-github" | ||
url = "https://github.com/eclipse/californium/issues" | ||
+++ | ||
|
||
The easiest way to tell us about a problem you experience with Californium is by opening an issue on our GitHub page. | ||
|
||
Please make sure to search the existing issues for similar symptoms before you open a new issue. |
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,11 @@ | ||
+++ | ||
title = "Connector" | ||
weight = 10 | ||
|
||
[asset] | ||
icon = "fas fa-link" | ||
url = "https://github.com/eclipse/californium/tree/master/element-connector" | ||
+++ | ||
|
||
The element-connector abstracts from the different transports CoAP can use. | ||
It provides the basic UDPConnector as well as the interface to implement new connectors like the DtlsConnector of Scandium. |
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,11 @@ | ||
+++ | ||
fragment = "items" | ||
#disabled = false | ||
date = "2019-10-29" | ||
weight = 140 | ||
background = "light" | ||
|
||
title = "More Components" | ||
#subtitle= "Column based items with images" | ||
#title_align = "left" # Default is center, can be left, right or center | ||
+++ |
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,10 @@ | ||
+++ | ||
title = "Tools" | ||
weight = 20 | ||
|
||
[asset] | ||
icon = "fas fa-toolbox" | ||
url = "https://github.com/eclipse/californium.tools" | ||
+++ | ||
|
||
This repository provides CoAP tools that also serve as examples. Use CoAPBench to benchmark your CoAP solutions or simply use our cf-client to interact with your devices from the command line. |
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,29 @@ | ||
+++ | ||
fragment = "item" | ||
#disabled = false | ||
date = "2019-10-29" | ||
weight = 110 | ||
background = "light" | ||
align = "right" | ||
|
||
title = "Californium (Cf) Core" | ||
#subtitle= "" | ||
|
||
# Subtitle pre and post item | ||
#pre = "Awesome screenshot" | ||
#post = "Showcasing Syna" | ||
|
||
[asset] | ||
# image = "Cf_box_512.png" | ||
image = "logos/Cf_256.png" | ||
|
||
[[buttons]] | ||
text = "Repository" | ||
url = "https://github.com/eclipse/californium" | ||
+++ | ||
|
||
The project is divided into five sub-projects. The Californium (Cf) Core provides the central framework with the protocol implementation to build your Internet of Things applications. The repository also includes example projects to get you started. All Californium sources are hosted on GitHub, so you can easily contribute through pull requests. | ||
|
||
Californium (Cf) is dual-licensed under EPL and EDL. The latter is a BSD-like license, which means the Cf CoAP framework can be used together with proprietary code to implement your IoT product! | ||
|
||
Cf is available from Maven Central and very easy to consume in your Java project. We have got your back covered from OSGi wrapper to HTTP-CoAP cross-proxy to advanced test suites that have been used at the ETSI Plugtests. |
Oops, something went wrong.