From 8a28249a88750c9b7c01c7a259fb2ea3edbf3058 Mon Sep 17 00:00:00 2001 From: c_meyer <998475a2-a9e1-483a-a46a-8f34462b7f5b@localhost> Date: Fri, 19 May 2023 08:32:43 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.textile => README.md | 64 ++++++++++++++++++++----------------- 1 file changed, 35 insertions(+), 29 deletions(-) rename README.textile => README.md (52%) diff --git a/README.textile b/README.md similarity index 52% rename from README.textile rename to README.md index 15ccef8..42342bf 100644 --- a/README.textile +++ b/README.md @@ -1,6 +1,8 @@ -h1. ThingSpeak +# ThingSpeak -"ThingSpeak":https://thingspeak.com is an open source "Internet of Things" application and API to store and retrieve data from things using HTTP over the Internet or via a Local Area Network. With ThingSpeak, you can create sensor logging applications, location tracking applications, and a social network of things with status updates. +[ThingSpeak](https://thingspeak.com) ist eine OpenSource "Internet of Things" Anwendung und API, mit der Daten von "Dingen" per HTTP über das Internet (oder LAN) empfangen und gespeichert werden können. Mit ThingSpeak, kann man verschiedene Anwendungen erstellen, die Sensor-Daten speichern, Standortdaten verwenden oder ein "soziales Netzwerk der Dinge" mit Status Updates versorgt. + +Dieser Fork ist dazu gedacht, auf einem eigenen Debian 11 - Server installiert zu werden. In addition to storing and retrieving numeric and alphanumeric data, the ThingSpeak API allows for numeric data processing such as timescaling, averaging, median, summing, and rounding. Each ThingSpeak Channel supports data entries of up to 8 data fields, latitude, longitude, elevation, and status. The channel feeds support JSON, XML, and CSV formats for integration into applications. @@ -8,60 +10,64 @@ The ThingSpeak application also features time zone management, read/write API ke Support for ThingSpeak is available on the "ThingSpeak Community":http://community.thingspeak.com/ site which features a "Blog":http://community.thingspeak.com/, "Forum":http://community.thingspeak.com/forum/, "Documentation":https://thingspeak.com/docs, and "Tutorials":https://thingspeak.com/docs/tutorials/. -h3. Before You Begin +### Before You Begin 1. Install Ruby 2, RubyGems, Rails 4, git, and a database like MySQL 2. Download the application using git: git clone git@github.com:iobridge/thingspeak.git 3. Change to the thingspeak directory and install the appropriate gems: sudo bundle install -h3. Configuration +### Configuration 1. Set your database configuration file at config/database.yml (see config/database.yml.example for an example) 2. Create the database: rake db:create 3. Create the database tables: rake db:schema:load -h3. Run The Application +### Run The Application 1. Start the server: rails server -Your application will now be running at http://localhost:3000/ +Your application will now be running at ```http://localhost:3000/``` -h2. Changing Application Text +## Changing Application Text Make changes to config/locales/en.yml To avoid errors, please ensure your lines start with spaces, not tabs. Set your application name using the 'application_name' key. -h2. (Optional) Email Setup +## (Optional) Email Setup Set your domain, user_name, and password in config/environment.rb -h2. (Optional) Admin Setup +## (Optional) Admin Setup -Open a rails console: rails console or RAILS_ENV=production rails console, depending on your environment -Add the admin user: AdminUser.create!(email: 'YOUR_ADMIN_EMAIL@EXAMPLE.COM', password: 'YOUR_PASSWORD', password_confirmation: 'YOUR_PASSWORD') -Exit the rails console: exit +Open a rails console: ```rails console``` or ```RAILS_ENV=production rails console```, depending on your environment +Add the admin user: ```AdminUser.create!(email: 'YOUR_ADMIN_EMAIL@EXAMPLE.COM', password: 'YOUR_PASSWORD', password_confirmation: 'YOUR_PASSWORD')``` +Exit the rails console: ```exit``` Login via the admin web interface at: "http://YOUR_DOMAIN.COM/admin" -h1. Installation on clean install of Ubuntu 12.04 LTS +# Installation on clean install of Ubuntu 12.04 LTS -sudo apt-get upgrade -sudo apt-get -y install build-essential mysql-server mysql-client libmysqlclient-dev libxml2-dev libxslt-dev git-core curl rubygems -\curl -sSL https://get.rvm.io | bash -s stable -rvm install 2.1 -git clone https://github.com/iobridge/thingspeak.git -cd thingspeak -bundle install -cp config/database.yml.example config/database.yml -rake db:create -rake db:schema:load -rails server +``` +sudo apt-get upgrade +sudo apt-get -y install build-essential mysql-server mysql-client libmysqlclient-dev libxml2-dev libxslt-dev git-core curl rubygems +\curl -sSL https://get.rvm.io | bash -s stable +rvm install 2.1 +git clone https://github.com/iobridge/thingspeak.git +cd thingspeak +bundle install +cp config/database.yml.example config/database.yml +rake db:create +rake db:schema:load +rails server +``` -h2. Upgrading existing installations +# Upgrading existing installations -git pull origin master -bundle install -rake db:migrate +``` +git pull origin master +bundle install +rake db:migrate +``` If your server is active you can restart it by going to the active terminal, hitting Ctrl-c, and then typing: -rails server +```rails server```