-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic worked examples for using the gateway
Signed-off-by: Tim Ward <timothyjward@apache.org>
- Loading branch information
1 parent
4b66817
commit d75fd80
Showing
4 changed files
with
42 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
Empty file.
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,33 @@ | ||
# Downloading and Launching sensiNact | ||
|
||
This worked example aims to get you started with running sensiNact for the first time. | ||
|
||
## Downloading sensiNact | ||
|
||
Eclipse sensiNact is published to the Eclipse Nexus repository instance at [https://repo.eclipse.org](https://repo.eclipse.org). You can find it directly there, or use the maven-dependency plugin to find it for you. | ||
|
||
mvn dependency:get -DremoteRepositories=https://repo.eclipse.org/content/groups/sensinact/ \ | ||
-Dartifact=org.eclipse.sensinact.gateway.distribution:assembly:0.0.2-SNAPSHOT:zip -Ddest=sensinact.zip | ||
|
||
## Installing sensiNact | ||
|
||
Once you have obtained the sensiNact assembly you can unzip it using your favourite zip tool | ||
|
||
unzip sensinact.zip | ||
|
||
The unzipped contents will include several folders and files including: | ||
|
||
* `configuration` - the folder containing the configuration for the gateway instance | ||
* `features` - the folder containing the available features that can be installed into this gateway | ||
* `launch` - the folder containing the sensiNact launcher responsible for bootstrapping the gateway | ||
* `repository` - a maven layout repository containing the bundles used by the gateway features | ||
* `start.sh` - a launch script for sensiNact | ||
|
||
## Starting sensiNact | ||
|
||
Starting sensiNact can be achieved simply by executing the start script | ||
|
||
./start.sh | ||
|
||
> [!WARNING] | ||
> If you are unable to execute the start script try setting the executable permission bit using `chmod +x start.sh` |
Empty file.