mirror of
https://github.com/usetrmnl/terminus.git
synced 2026-08-13 14:29:27 -07:00
Updated project name as terminus instead of byos_hanami
Necessary to match repository name with project name. Milestone: minor
This commit is contained in:
@@ -2,7 +2,7 @@ organization:
|
||||
label: "TRMNL"
|
||||
uri: "https://trmnl.com"
|
||||
project:
|
||||
name: "byos_hanami"
|
||||
name: "terminus"
|
||||
owner: "usetrmnl"
|
||||
uri:
|
||||
icon: "%<organization_uri>s/favicon.ico"
|
||||
|
||||
+1
-1
@@ -60,7 +60,7 @@ STEPS
|
||||
COPY .ruby-version Gemfile Gemfile.lock .node-version package.json package-lock.json ./
|
||||
|
||||
RUN <<STEPS
|
||||
git clone --bare --depth 1 --single-branch https://github.com/usetrmnl/byos_hanami .git
|
||||
git clone --bare --depth 1 --single-branch https://github.com/usetrmnl/terminus
|
||||
git -C .git fetch --tags
|
||||
bundle install
|
||||
npm ci
|
||||
|
||||
+8
-8
@@ -34,9 +34,9 @@
|
||||
|
||||
= Terminus
|
||||
|
||||
image:https://dl.circleci.com/status-badge/img/gh/usetrmnl/byos_hanami/tree/main.svg?style=svg[CircleCI, link=https://dl.circleci.com/status-badge/redirect/gh/usetrmnl/byos_hanami/tree/main]
|
||||
image:https://github.com/usetrmnl/byos_hanami/actions/workflows/docker.yml/badge.svg[Docker, link="https://github.com/usetrmnl/byos_hanami/actions"]
|
||||
image:https://alchemists.io/images/projects/caliber/coverage.svg[Code Coverage, link=https://dl.circleci.com/status-badge/redirect/gh/usetrmnl/byos_hanami/tree/main, width=139.1, height=20]
|
||||
image:https://dl.circleci.com/status-badge/img/gh/usetrmnl/terminus/tree/main.svg?style=svg[CircleCI, link=https://dl.circleci.com/status-badge/redirect/gh/usetrmnl/terminus/tree/main]
|
||||
image:https://github.com/usetrmnl/terminus/actions/workflows/docker.yml/badge.svg[Docker, link="https://github.com/usetrmnl/terminus/actions"]
|
||||
image:https://alchemists.io/images/projects/caliber/coverage.svg[Code Coverage, link=https://dl.circleci.com/status-badge/redirect/gh/usetrmnl/terminus/tree/main, width=139.1, height=20]
|
||||
image:https://alchemists.io/images/badges/style.svg[Style, link=https://alchemists.io/projects/caliber, width=81, height=20]
|
||||
|
||||
Terminus is a {ruby_link}/{hanami_link} web server that allows you to manage {trmnl_link} devices running on your own local network or hosted cloud. This is our flagship BYOS implementation that aims to be compatible with our {trmnl_link} Core server but _also different_ since this open source solution provides features not possible in our Core application.
|
||||
@@ -115,7 +115,7 @@ To immediately spin up Terminus on your local machine using {docker_link}, run:
|
||||
|
||||
[source,bash]
|
||||
----
|
||||
curl https://raw.githubusercontent.com/usetrmnl/byos_hanami/refs/heads/main/scripts/docker/quick.sh | bash
|
||||
curl https://raw.githubusercontent.com/usetrmnl/terminus/refs/heads/main/scripts/docker/quick.sh | bash
|
||||
----
|
||||
|
||||
Once launched, open `http://localhost:2300` in your browser then click the _Register_ link to register and log into the system.
|
||||
@@ -128,7 +128,7 @@ To set up this project for local development, run:
|
||||
|
||||
[source,bash]
|
||||
----
|
||||
git clone https://github.com/usetrmnl/byos_hanami terminus
|
||||
git clone https://github.com/usetrmnl/terminus
|
||||
cd terminus
|
||||
bin/setup
|
||||
----
|
||||
@@ -214,8 +214,8 @@ Connecting devices requires using the WiFi captive portal on your mobile phone t
|
||||
|
||||
In accordance with the {unbrickable_pledge_link}, the latest version of Terminus always supports the latest version of our {firmware_link}. If you are running on older firmware, you'll need to use an older version of Terminus. Here's a rough breakdown of the Firmware version history where changes were applied that might cause issues if you haven't upgraded your devices in a while:
|
||||
|
||||
* *Firmware 1.6.9* (and lower): Supported by Terminus link:https://github.com/usetrmnl/byos_hanami/releases/tag/0.41.0[0.41.0] and lower.
|
||||
* *Firmware 1.6.10* (and higher): Supported by Terminus link:https://github.com/usetrmnl/byos_hanami/releases/tag/0.42.0[0.42.0] and higher.
|
||||
* *Firmware 1.6.9* (and lower): Supported by Terminus link:https://github.com/usetrmnl/terminus/releases/tag/0.41.0[0.41.0] and lower.
|
||||
* *Firmware 1.6.10* (and higher): Supported by Terminus link:https://github.com/usetrmnl/terminus/releases/tag/0.42.0[0.42.0] and higher.
|
||||
|
||||
=== Extensions
|
||||
|
||||
@@ -270,7 +270,7 @@ Code quality is an important and vital aspect of the work on this project. The f
|
||||
|
||||
To view up-to-date code coverage details, follow these steps:
|
||||
|
||||
* Visit the link:https://app.circleci.com/pipelines/github/usetrmnl/byos_hanami?branch=main[Circle CI] build page.
|
||||
* Visit the link:https://app.circleci.com/pipelines/github/usetrmnl/terminus?branch=main[Circle CI] build page.
|
||||
* Click on the latest "Success" build at the top of the page.
|
||||
* Click on `build`.
|
||||
* Click on ARTIFACTS.
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
</header>
|
||||
|
||||
<%= scope(:popover_default_content, name: :overview, label: "Overview").render do %>
|
||||
<p>Allows you to manage firmware updates for your devices. New versions will automatically appear via the Firmware Poller (see <a href="https://github.com/usetrmnl/byos_hanami/blob/main/doc/jobs.adoc">Jobs</a> documentation for details). You can also add your own custom firmware and your devices will automatically update when the new version is higher than the previous version.</p>
|
||||
<p>Allows you to manage firmware updates for your devices. New versions will automatically appear via the Firmware Poller (see <a href="https://github.com/usetrmnl/terminus/blob/main/doc/jobs.adoc">Jobs</a> documentation for details). You can also add your own custom firmware and your devices will automatically update when the new version is higher than the previous version.</p>
|
||||
|
||||
<p>💡 To revert to a previous version, for example, do the following:</p>
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
<%= scope(:popover_default_content, name: :image, label: "Image").render do %>
|
||||
<p>The image associated with your screen. <em>Must</em> be a properly processed image that matches the associated model specifications. If you need to create a processed image first, please use the <%= link_to "Designer", routes.path(:designer) %>, <%= link_to "Extensions", routes.path(:extensions) %>, or <a href="https://github.com/usetrmnl/byos_hanami/blob/main/doc/api.adoc#screens">Screens API</a> before uploading.</p>
|
||||
<p>The image associated with your screen. <em>Must</em> be a properly processed image that matches the associated model specifications. If you need to create a processed image first, please use the <%= link_to "Designer", routes.path(:designer) %>, <%= link_to "Extensions", routes.path(:extensions) %>, or <a href="https://github.com/usetrmnl/terminus/blob/main/doc/api.adoc#screens">Screens API</a> before uploading.</p>
|
||||
<% end %>
|
||||
|
||||
@@ -20,6 +20,6 @@
|
||||
</li>
|
||||
|
||||
<li class="item">
|
||||
<%= link_to "Source", "https://github.com/usetrmnl/byos_hanami", class: :link %>
|
||||
<%= link_to "Source", "https://github.com/usetrmnl/terminus", class: :link %>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -50,7 +50,7 @@ module Terminus
|
||||
settings = Hanami.app[:settings]
|
||||
|
||||
link_to "Latest (ahead of #{settings.git_tag})",
|
||||
"https://github.com/usetrmnl/byos_hanami/commit/#{settings.git_latest_sha}",
|
||||
"https://github.com/usetrmnl/terminus/commit/#{settings.git_latest_sha}",
|
||||
class: :link
|
||||
end
|
||||
|
||||
@@ -58,7 +58,7 @@ module Terminus
|
||||
tag = Hanami.app[:settings].git_tag
|
||||
|
||||
link_to "Version #{tag}",
|
||||
"https://github.com/usetrmnl/byos_hanami/releases/tag/#{tag}",
|
||||
"https://github.com/usetrmnl/terminus/releases/tag/#{tag}",
|
||||
class: :link
|
||||
end
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ Pure CSS is used in order to avoid pulling in complicated frameworks. All styles
|
||||
|
||||
== HTML/CSS Sanitization
|
||||
|
||||
The link:https://github.com/rgrove/sanitize[Santize] gem is used to sanitize HTML/CSS when using the console, API, or UI. All of this configured via the `Terminus::Sanitizer` class which defaults to the `Sanitize::Config::RELAXED` style with additional support for `style` and `source` elements. If you find elements being stripped from your HTML/CSS content, this is why. Feel free to open an link:https://github.com/usetrmnl/byos_hanami/issues[issue] if you need additional support.
|
||||
The link:https://github.com/rgrove/sanitize[Santize] gem is used to sanitize HTML/CSS when using the console, API, or UI. All of this configured via the `Terminus::Sanitizer` class which defaults to the `Sanitize::Config::RELAXED` style with additional support for `style` and `source` elements. If you find elements being stripped from your HTML/CSS content, this is why. Feel free to open an link:https://github.com/usetrmnl/terminus/issues[issue] if you need additional support.
|
||||
|
||||
== Logging
|
||||
|
||||
|
||||
+2
-2
@@ -8,7 +8,7 @@
|
||||
|
||||
= Docker
|
||||
|
||||
We provide {docker_link} support in case you don't want to use our {ruby_link} stack. This includes both a development and production environment. In most cases, you'll want to use {docker_compose_link} to manage the stack. Pre-built Docker link:https://github.com/usetrmnl/byos_hanami/pkgs/container/terminus[images] for AMD 64 and ARM 64 are included as well.
|
||||
We provide {docker_link} support in case you don't want to use our {ruby_link} stack. This includes both a development and production environment. In most cases, you'll want to use {docker_compose_link} to manage the stack. Pre-built Docker link:https://github.com/usetrmnl/terminus/pkgs/container/terminus[images] for AMD 64 and ARM 64 are included as well.
|
||||
|
||||
Continue reading to learn more.
|
||||
|
||||
@@ -20,7 +20,7 @@ To get setup, run:
|
||||
|
||||
[source,bash]
|
||||
----
|
||||
git clone https://github.com/usetrmnl/byos_hanami terminus
|
||||
git clone https://github.com/usetrmnl/terminus
|
||||
cd terminus
|
||||
bin/setup docker
|
||||
----
|
||||
|
||||
@@ -25,7 +25,7 @@ set -o nounset
|
||||
set -o pipefail
|
||||
IFS=$'\n\t'
|
||||
|
||||
git clone https://github.com/usetrmnl/byos_hanami terminus
|
||||
git clone https://github.com/usetrmnl/terminus
|
||||
cd terminus
|
||||
bin/setup docker
|
||||
----
|
||||
|
||||
@@ -50,7 +50,7 @@ if [[ -d "terminus" ]]; then
|
||||
abort "Terminus project directory exists. Please remove or run from a different location."
|
||||
fi
|
||||
|
||||
git clone https://github.com/usetrmnl/byos_hanami terminus
|
||||
git clone https://github.com/usetrmnl/terminus
|
||||
cd terminus
|
||||
printf "%s\n" "Terminus has been cloned into: $PWD."
|
||||
bin/setup docker
|
||||
|
||||
@@ -72,7 +72,7 @@ RSpec.describe Terminus::Views::Helpers do
|
||||
.and_return(latest_sha)
|
||||
|
||||
expect(helper.git_link(kernel:)).to eq(
|
||||
%(<a class="link" href="https://github.com/usetrmnl/byos_hanami/releases/tag/1.2.3">) \
|
||||
%(<a class="link" href="https://github.com/usetrmnl/terminus/releases/tag/1.2.3">) \
|
||||
"Version 1.2.3</a>"
|
||||
)
|
||||
end
|
||||
@@ -82,7 +82,7 @@ RSpec.describe Terminus::Views::Helpers do
|
||||
.and_return("different")
|
||||
|
||||
expect(helper.git_link(kernel:)).to eq(
|
||||
%(<a class="link" href="https://github.com/usetrmnl/byos_hanami/commit/abcdefghijkl">) \
|
||||
%(<a class="link" href="https://github.com/usetrmnl/terminus/commit/abcdefghijkl">) \
|
||||
"Latest (ahead of 1.2.3)</a>"
|
||||
)
|
||||
end
|
||||
@@ -91,7 +91,7 @@ RSpec.describe Terminus::Views::Helpers do
|
||||
describe "#git_latest_link" do
|
||||
it "answers version link when latest and tag SHAs match" do
|
||||
expect(helper.git_latest_link).to eq(
|
||||
%(<a class="link" href="https://github.com/usetrmnl/byos_hanami/commit/abcdefghijkl">) \
|
||||
%(<a class="link" href="https://github.com/usetrmnl/terminus/commit/abcdefghijkl">) \
|
||||
"Latest (ahead of 1.2.3)</a>"
|
||||
)
|
||||
end
|
||||
@@ -100,7 +100,7 @@ RSpec.describe Terminus::Views::Helpers do
|
||||
describe "#git_version_link" do
|
||||
it "answers version link when latest and tag SHAs match" do
|
||||
expect(helper.git_version_link).to eq(
|
||||
%(<a class="link" href="https://github.com/usetrmnl/byos_hanami/releases/tag/1.2.3">) \
|
||||
%(<a class="link" href="https://github.com/usetrmnl/terminus/releases/tag/1.2.3">) \
|
||||
"Version 1.2.3</a>"
|
||||
)
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user