Compare commits
45 Commits
| Author | SHA1 | Date |
|---|---|---|
Paulo Truta
|
dbc831e972 | |
|
Paulo Truta
|
19acbcbaad | |
dependabot[bot]
|
1e0a5df370 | |
|
Paulo Truta
|
7913be080d | |
|
Paulo Truta
|
e80aaf7d18 | |
|
Paulo Truta
|
b11034dd17 | |
|
Paulo Truta
|
80fc8b40cd | |
|
Paulo Truta
|
01f423ee84 | |
|
Paulo Truta
|
a8b1da4b7c | |
|
Paulo Truta
|
6ccd4a3299 | |
|
Paulo Truta
|
42b1a34ca7 | |
|
Paulo Truta
|
4bb343769f | |
|
Paulo Truta
|
3bb6200b1c | |
|
dependabot[bot]
|
eae72b0a79 | |
Malachi Soord
|
8be566afb9 | |
|
Malachi Soord
|
9c2a0dbefe | |
|
dependabot[bot]
|
4e399f63ea | |
|
Paulo Truta
|
e238e9d71d | |
=
|
db56530311 | |
|
=
|
319acbd0e1 | |
|
Paulo Truta
|
f0047a7a0c | |
|
Paulo Truta
|
5c736a1b85 | |
|
=
|
ca7f4af7fe | |
|
Paulo Truta
|
445bc41d0e | |
|
=
|
8bf26a334c | |
|
Paulo Truta
|
e009c1f55d | |
|
Paulo Truta
|
284acb18a4 | |
|
Paulo Truta
|
8d0de36cdd | |
|
Paulo Truta
|
113785def4 | |
|
Paulo Truta
|
df13bf705d | |
|
Paulo Truta
|
335b7ec29e | |
|
Paulo Truta
|
13275f80a5 | |
|
Paulo Truta
|
04cdba7479 | |
|
Paulo Truta
|
a66ff40e65 | |
|
Paulo Truta
|
f7823b9e20 | |
|
Paulo Truta
|
ece500c342 | |
|
Paulo Truta
|
161ec76eb9 | |
|
dependabot[bot]
|
d9720a48c9 | |
|
dependabot[bot]
|
1ba5a8f506 | |
|
Malachi Soord
|
25d5ca74f8 | |
|
Paulo Truta
|
d62cb57222 | |
|
Malachi Soord
|
0680b7ffb9 | |
|
Paulo Truta
|
83d2fdcae1 | |
|
Paulo Truta
|
864d1e8f0f | |
|
Malachi Soord
|
7430f0c8ce |
|
|
@ -0,0 +1,10 @@
|
|||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "gomod"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
|
|
@ -13,16 +13,16 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Set up Go
|
||||
uses: actions/setup-go@v2
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ^1.15
|
||||
go-version: '1.20.2'
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v2
|
||||
uses: actions/checkout@v4
|
||||
- name: Build
|
||||
run: make build
|
||||
- name: Test
|
||||
run: make test-with-coverage
|
||||
- uses: codecov/codecov-action@v1
|
||||
with:
|
||||
token: ${{ secrets.CODECOV_TOKEN }}
|
||||
files: coverage.out
|
||||
# - uses: codecov/codecov-action@v1
|
||||
# with:
|
||||
# token: ${{ secrets.CODECOV_TOKEN }}
|
||||
# files: coverage.out
|
||||
|
|
|
|||
|
|
@ -21,3 +21,6 @@ main
|
|||
# Build
|
||||
|
||||
/bin
|
||||
|
||||
# Logs from executed scripts
|
||||
/scripts/output.log
|
||||
|
|
|
|||
|
|
@ -0,0 +1,236 @@
|
|||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Build",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
|
||||
},
|
||||
"group": {
|
||||
"kind": "build",
|
||||
"isDefault": true
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build All",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build-all"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build Prod",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build-prod"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build Cloud",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build-cloud"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build ARM64",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build-arm64"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build ARMHF",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build-armhf"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Build AMD64",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["build-amd64"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"group": "build",
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Clean",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["clean"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Test",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["test"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Test with Coverage",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["test-with-coverage"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Run",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["run"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["install"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install Prod",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["install-prod"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install Cloud",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["install-cloud"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install ARM64",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["install-arm64"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install ARMHF",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["install-armhf"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Install AMD64",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["install-amd64"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Start",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["start"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Stop",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["stop"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Restart",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["restart"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Status",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["status"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
},
|
||||
{
|
||||
"label": "Logs",
|
||||
"type": "shell",
|
||||
"command": "make",
|
||||
"args": ["log"],
|
||||
"options": {
|
||||
"cwd": "${workspaceFolder}"
|
||||
},
|
||||
"problemMatcher": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# Changelog
|
||||
|
||||
## [1.3.2] - 08-12-2024
|
||||
|
||||
* Fix to Browser Dev feature:
|
||||
* Checking browser dev url when internet_accessible was checking the incorrect path. This is now fixed.
|
||||
|
||||
## [1.3.1] - 08-12-2024
|
||||
|
||||
* Fixes to Browser Dev feature:
|
||||
* Now edgeboxctl also fetches or generates the browser dev environment url and saves it into an option both when starting, and every time the browser dev status is fetched.
|
||||
|
||||
## [1.3.0] - 05-12-2024
|
||||
|
||||
* Added Edgebox Browser Development Environment Feature Support
|
||||
* Added tasks for handling browser development environment into tasks.go
|
||||
* Added executable tasks to ExecuteTask and scheduled ones to ExecuteSchedules
|
||||
* Other bug fixes and improvements.
|
||||
|
||||
### Missing Past Releases
|
||||
|
||||
Release notes for past versions are not available in this file. Please refer to the [GitHub releases](https://hithub.com/edgebox-iot/edgeboxctl/releases) for more information. Feel free to contribute to this file by adding missing release notes.
|
||||
|
||||
|
|
@ -1,11 +1,9 @@
|
|||
FROM golang:latest
|
||||
FROM golang:1.20.2
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY ./ /app
|
||||
|
||||
RUN go mod download
|
||||
RUN go install github.com/githubnemo/CompileDaemon@latest
|
||||
|
||||
RUN go get github.com/githubnemo/CompileDaemon
|
||||
|
||||
ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl
|
||||
ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl-$(go env GOOS)-$(go env GOARCH)
|
||||
|
|
|
|||
713
LICENSE
713
LICENSE
|
|
@ -1,674 +1,93 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
Elastic License 2.0
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
URL: https://www.elastic.co/licensing/elastic-license
|
||||
|
||||
Preamble
|
||||
## Acceptance
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
By using the software, you agree to all of the terms and conditions below.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
## Copyright License
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
The licensor grants you a non-exclusive, royalty-free, worldwide,
|
||||
non-sublicensable, non-transferable license to use, copy, distribute, make
|
||||
available, and prepare derivative works of the software, in each case subject to
|
||||
the limitations and conditions below.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
## Limitations
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
You may not provide the software to third parties as a hosted or managed
|
||||
service, where the service provides users with access to any substantial set of
|
||||
the features or functionality of the software.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
You may not move, change, disable, or circumvent the license key functionality
|
||||
in the software, and you may not remove or obscure any functionality in the
|
||||
software that is protected by the license key.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
You may not alter, remove, or obscure any licensing, copyright, or other notices
|
||||
of the licensor in the software. Any use of the licensor’s trademarks is subject
|
||||
to applicable law.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
## Patents
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
The licensor grants you a license, under any patent claims the licensor can
|
||||
license, or becomes able to license, to make, have made, use, sell, offer for
|
||||
sale, import and have imported the software, in each case subject to the
|
||||
limitations and conditions in this license. This license does not cover any
|
||||
patent claims that you cause to be infringed by modifications or additions to
|
||||
the software. If you or your company make any written claim that the software
|
||||
infringes or contributes to infringement of any patent, your patent license for
|
||||
the software granted under these terms ends immediately. If your company makes
|
||||
such a claim, your patent license ends immediately for work on behalf of your
|
||||
company.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
## Notices
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
You must ensure that anyone who gets a copy of any part of the software from you
|
||||
also gets a copy of these terms.
|
||||
|
||||
0. Definitions.
|
||||
If you modify the software, you must include in any modified copies of the
|
||||
software prominent notices stating that you have modified the software.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
## No Other Rights
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
These terms do not imply any licenses other than those expressly granted in
|
||||
these terms.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
## Termination
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
If you use the software in violation of these terms, such use is not licensed,
|
||||
and your licenses will automatically terminate. If the licensor provides you
|
||||
with a notice of your violation, and you cease all violation of this license no
|
||||
later than 30 days after you receive that notice, your licenses will be
|
||||
reinstated retroactively. However, if you violate these terms after such
|
||||
reinstatement, any additional violation of these terms will cause your licenses
|
||||
to terminate automatically and permanently.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
## No Liability
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
*As far as the law allows, the software comes as is, without any warranty or
|
||||
condition, and the licensor will not be liable to you for any damages arising
|
||||
out of these terms or the use or nature of the software, under any kind of
|
||||
legal claim.*
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
## Definitions
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
The **licensor** is the entity offering these terms, and the **software** is the
|
||||
software the licensor makes available under these terms, including any portion
|
||||
of it.
|
||||
|
||||
1. Source Code.
|
||||
**you** refers to the individual or entity agreeing to these terms.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
**your company** is any legal entity, sole proprietorship, or other kind of
|
||||
organization that you work for, plus all organizations that have control over,
|
||||
are under the control of, or are under common control with that
|
||||
organization. **control** means ownership of substantially all the assets of an
|
||||
entity, or the power to direct its management and policies by vote, contract, or
|
||||
otherwise. Control can be direct or indirect.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
**your licenses** are all the licenses granted to you for the software under
|
||||
these terms.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
**use** means anything you do with the software requiring one of your licenses.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
**trademark** means trademarks, service marks, and similar rights.
|
||||
|
|
|
|||
88
Makefile
88
Makefile
|
|
@ -1,32 +1,114 @@
|
|||
PROJECT?=github.com/edgebox-iot/edgeboxctl
|
||||
.DEFAULT_GOAL := build
|
||||
|
||||
PROJECT ?= github.com/edgebox-iot/edgeboxctl
|
||||
RELEASE ?= dev
|
||||
COMMIT := $(shell git rev-parse --short HEAD)
|
||||
BUILD_DATE := $(shell date -u '+%Y-%m-%d_%H:%M:%S')
|
||||
BUILD_DIR = bin
|
||||
GOOS := $(shell go env GOOS)
|
||||
GOARCH := $(shell go env GOARCH)
|
||||
|
||||
|
||||
build-all:
|
||||
@echo "\n🏗️ Building all architectures for ${RELEASE} mode"
|
||||
@echo "🟡 This will build all supported architectures and release combinations. It can take a while...\n"
|
||||
|
||||
GOOS=linux GOARCH=amd64 make build
|
||||
GOOS=linux GOARCH=arm make build
|
||||
|
||||
@echo "\n🟢 All builds completed and available at ./bin/ \n"
|
||||
|
||||
build-prod:
|
||||
GOOS=linux GOARCH=arm RELEASE=prod make build
|
||||
|
||||
build-cloud:
|
||||
GOOS=linux GOARCH=amd64 RELEASE=cloud make build
|
||||
|
||||
build-arm64:
|
||||
GOOS=linux GOARCH=arm64 RELEASE=prod make build
|
||||
|
||||
build-armhf:
|
||||
GOOS=linux GOARCH=arm RELEASE=prod make build
|
||||
|
||||
build-amd64:
|
||||
GOOS=linux GOARCH=amd64 RELEASE=prod make build
|
||||
|
||||
|
||||
build:
|
||||
@echo "Building ${GOOS}-${GOARCH}"
|
||||
@echo "\n🏗️ Building edgeboxctl (${RELEASE} release) on ${GOOS} (${GOARCH})"
|
||||
@echo "📦 Binary will be saved in ./${BUILD_DIR}/edgeboxctl-${GOOS}-${GOARCH}\n"
|
||||
|
||||
GOOS=${GOOS} GOARCH=${GOARCH} go build \
|
||||
-trimpath -ldflags "-s -w -X ${PROJECT}/internal/diagnostics.Version=${RELEASE} \
|
||||
-X ${PROJECT}/internal/diagnostics.Commit=${COMMIT} \
|
||||
-X ${PROJECT}/internal/diagnostics.BuildDate=${BUILD_DATE}" \
|
||||
-o bin/edgeboxctl-${GOOS}-${GOARCH} ${PROJECT}/cmd/edgeboxctl
|
||||
cp ./bin/edgeboxctl-${GOOS}-${GOARCH} ./bin/edgeboxctl
|
||||
|
||||
@echo "\n🟢 Build task completed\n"
|
||||
|
||||
clean:
|
||||
@echo "🧹 Cleaning build directory and go cache\n"
|
||||
|
||||
rm -rf ${BUILD_DIR}
|
||||
go clean
|
||||
|
||||
@echo "\n🟢 Clean task completed\n"
|
||||
|
||||
test:
|
||||
go test -tags=unit -timeout=600s -v ./...
|
||||
|
||||
test-with-coverage:
|
||||
go test -tags=unit -timeout=600s -v ./... -coverprofile=coverage.out
|
||||
|
||||
run:
|
||||
@echo "\n🚀 Running edgeboxctl\n"
|
||||
./bin/edgeboxctl-${GOOS}-${GOARCH}
|
||||
|
||||
install:
|
||||
@echo "📦 Installing edgeboxctl service (${RELEASE}) for ${GOOS} (${GOARCH})\n"
|
||||
|
||||
@echo "🚧 Stopping edgeboxctl service if it is running"
|
||||
sudo systemctl stop edgeboxctl || true
|
||||
|
||||
@echo "\n🗑️ Removing old edgeboxctl binary and service"
|
||||
sudo rm -rf /usr/local/bin/edgeboxctl /usr/local/sbin/edgeboctl /lib/systemd/system/edgeboxctl.service
|
||||
|
||||
@echo "\n🚚 Copying edgeboxctl binary to /usr/local/bin"
|
||||
sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/bin/edgeboxctl
|
||||
sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/sbin/edgeboxctl
|
||||
|
||||
@echo "\n🚚 Copying edgeboxctl service to /lib/systemd/system"
|
||||
sudo cp ./edgeboxctl.service /lib/systemd/system/edgeboxctl.service
|
||||
sudo systemctl daemon-reload
|
||||
|
||||
@echo "\n 🚀 To start edgeboxctl run: make start"
|
||||
@echo "🟢 Edgeboxctl installed successfully\n"
|
||||
|
||||
install-prod: build-prod install
|
||||
install-cloud: build-cloud install
|
||||
install-arm64: build-arm64 install
|
||||
install-armhf: build-armhf install
|
||||
install-amd64: build-amd64 install
|
||||
|
||||
start:
|
||||
@echo "\n 🚀 Starting edgeboxctl service\n"
|
||||
systemctl start edgeboxctl
|
||||
@echo "\n 🟢 Edgebox service started\n"
|
||||
|
||||
stop:
|
||||
@echo "\n✋ Stopping edgeboxctl service\n"
|
||||
systemctl stop edgeboxctl
|
||||
@echo "\n 🟢 Edgebox service stopped\n"
|
||||
|
||||
restart:
|
||||
@echo "\n💫 Restarting edgeboxctl service\n"
|
||||
systemctl restart edgeboxctl
|
||||
@echo "\n 🟢 Edgebox service restarted\n"
|
||||
|
||||
status:
|
||||
@echo "\nℹ️ edgeboxctl Service Info:\n"
|
||||
systemctl status edgeboxctl
|
||||
|
||||
log:
|
||||
@echo "\n📰 edgeboxctl service logs:\n"
|
||||
journalctl -fu edgeboxctl
|
||||
|
|
|
|||
58
README.md
58
README.md
|
|
@ -1,21 +1,3 @@
|
|||
|
||||
<!-- PROJECT SHIELDS -->
|
||||
<!--
|
||||
*** Using markdown "reference style" links for readability.
|
||||
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
||||
*** See the bottom of this document for the declaration of the reference variables
|
||||
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
||||
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
||||
-->
|
||||
[![Contributors][contributors-shield]][contributors-url]
|
||||
[![Forks][forks-shield]][forks-url]
|
||||
[![Stargazers][stars-shield]][stars-url]
|
||||
[![Issues][issues-shield]][issues-url]
|
||||
[![MIT License][license-shield]][license-url]
|
||||
[![LinkedIn][linkedin-shield]][linkedin-url]
|
||||
|
||||
|
||||
|
||||
<!-- PROJECT LOGO -->
|
||||
<br />
|
||||
<p align="center">
|
||||
|
|
@ -26,9 +8,7 @@
|
|||
<h3 align="center">Edgebox Control Module</h3>
|
||||
|
||||
<p align="center">
|
||||
A System Control module written in Go. Its resonsability is to configure dependencies and perform system tasks, automatically in a schedule, or by command.
|
||||
<br />
|
||||
<a href="https://github.com/github_username/edgeboxctl"><strong>Explore the docs »</strong></a>
|
||||
A System Control module written in Go. Its responsibility is to configure dependencies and perform system tasks, automatically on a schedule, or on demand.
|
||||
<br />
|
||||
<br />
|
||||
<a href="https://github.com/github_username/edgeboxctl/issues">Report Bug</a>
|
||||
|
|
@ -58,9 +38,7 @@
|
|||
<!-- ABOUT THE PROJECT -->
|
||||
## About The Project
|
||||
|
||||
[![Edgebox Screen Shot][product-screenshot]](https://edgebox.co)
|
||||
|
||||
Edgebox is a small box that connects alongside your home internet router. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day.
|
||||
Edgebox is an easy to configure and use system. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day.
|
||||
|
||||
|
||||
### Built With
|
||||
|
|
@ -78,18 +56,16 @@ To get a local copy up and running follow these simple steps.
|
|||
|
||||
### Prerequisites
|
||||
|
||||
If you're installing this to run natively in the system, you better be doing it inside of the [Development Virtual Machine](https://github.com/edgebox-iot/devm). This software can do destructive action in the system is is running. You've been warned.
|
||||
If you're running for development purposes, a docker container suffices, so make sure you have:
|
||||
|
||||
If you're running for development purposes, a Docker container suffices, so make sure you have:
|
||||
* Docker
|
||||
* Docker Compose
|
||||
```sh
|
||||
sudo apt-get install docker docker-compose
|
||||
```
|
||||
* docker
|
||||
* docker compose
|
||||
|
||||
Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
|
||||
|
||||
Aditionally, edgeboxctl needs the following bash commands available wherever it runs:
|
||||
Aditionally, `edgeboxctl` needs the following bash commands available wherever it runs:
|
||||
|
||||
* `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`)
|
||||
* `sh`
|
||||
* `rm`
|
||||
* `systemctl`
|
||||
|
|
@ -140,20 +116,4 @@ Contributions are what make the open source community such an amazing place to b
|
|||
<!-- LICENSE -->
|
||||
## License
|
||||
|
||||
Distributed under the MIT License. See `LICENSE` for more information.
|
||||
|
||||
|
||||
<!-- MARKDOWN LINKS & IMAGES -->
|
||||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/edgebox-iot/edgeboxctl.svg?style=flat-square
|
||||
[contributors-url]: https://github.com/edgebox-iot/edgeboxctl/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/edgebox-iot/edgeboxctl.svg?style=flat-square
|
||||
[forks-url]: https://github.com/edgebox-iot/edgeboxctl/network/members
|
||||
[stars-shield]: https://img.shields.io/github/stars/edgebox-iot/edgeboxctl.svg?style=flat-square
|
||||
[stars-url]: https://github.com/edgebox-iot/edgeboxctl/stargazers
|
||||
[issues-shield]: https://img.shields.io/github/issues/edgebox-iot/edgeboxctl.svg?style=flat-square
|
||||
[issues-url]: https://github.com/edgebox-iot/edgeboxctl/issues
|
||||
[license-shield]: https://img.shields.io/github/license/edgebox-iot/edgeboxctl.svg?style=flat-square
|
||||
[license-url]: https://github.com/edgebox-iot/edgeboxctl/blob/master/LICENSE.txt
|
||||
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
|
||||
[linkedin-url]: https://linkedin.com/in/edgebox-iot
|
||||
Distributed under the Elastic License 2.0. See `LICENSE` for more information.
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ func printDbDetails() {
|
|||
|
||||
// IsSystemReady : Checks hability of the service to execute commands (Only after "edgebox --build" is ran at least once via SSH, or if built for distribution)
|
||||
func isSystemReady() bool {
|
||||
_, err := os.Stat("/home/system/components/ws/.ready")
|
||||
_, err := os.Stat(utils.GetPath(utils.WsPath) + ".ready")
|
||||
return !os.IsNotExist(err)
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,29 @@
|
|||
[Unit]
|
||||
Description=Edgebox Control Module Service
|
||||
ConditionPathExists=/home/system/
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User=root
|
||||
Group=root
|
||||
LimitNOFILE=1024
|
||||
|
||||
Restart=on-failure
|
||||
RestartSec=10
|
||||
startLimitIntervalSec=60
|
||||
|
||||
WorkingDirectory=/home/system/components/edgeboxctl
|
||||
ExecStart=edgeboxctl --name=edgebox-cloud
|
||||
|
||||
# make sure log directory exists and owned by syslog
|
||||
PermissionsStartOnly=true
|
||||
ExecStartPre=/bin/mkdir -p /var/log/edgeboxctl
|
||||
ExecStartPre=/bin/chown root:root /var/log/edgeboxctl
|
||||
ExecStartPre=/bin/chmod 755 /var/log/edgeboxctl
|
||||
StandardOutput=syslog
|
||||
StandardError=syslog
|
||||
SyslogIdentifier=edgeboxctl
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
1
go.mod
1
go.mod
|
|
@ -8,6 +8,7 @@ require (
|
|||
github.com/dustin/go-humanize v1.0.0 // indirect
|
||||
github.com/go-ole/go-ole v1.2.5 // indirect
|
||||
github.com/go-sql-driver/mysql v1.5.0
|
||||
github.com/go-yaml/yaml v2.1.0+incompatible // indirect
|
||||
github.com/joho/godotenv v1.3.0
|
||||
github.com/mattn/go-sqlite3 v1.14.7 // indirect
|
||||
github.com/shirou/gopsutil v3.21.4+incompatible // indirect
|
||||
|
|
|
|||
2
go.sum
2
go.sum
|
|
@ -11,6 +11,8 @@ github.com/go-ole/go-ole v1.2.5 h1:t4MGB5xEDZvXI+0rMjjsfBsD7yAgp/s9ZDkL1JndXwY=
|
|||
github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0=
|
||||
github.com/go-sql-driver/mysql v1.5.0 h1:ozyZYNQW3x3HtqT1jira07DN2PArx2v7/mN66gGcHOs=
|
||||
github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
|
||||
github.com/go-yaml/yaml v2.1.0+incompatible h1:RYi2hDdss1u4YE7GwixGzWwVo47T8UQwnTLB6vQiq+o=
|
||||
github.com/go-yaml/yaml v2.1.0+incompatible/go.mod h1:w2MrLa16VYP0jy6N7M5kHaCkaLENm+P+Tv+MfurjSw0=
|
||||
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
|
||||
github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
|
||||
github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
|
||||
|
|
|
|||
|
|
@ -0,0 +1,28 @@
|
|||
package backups
|
||||
|
||||
// import (
|
||||
// "fmt"
|
||||
// "os"
|
||||
// "path/filepath"
|
||||
// "strings"
|
||||
|
||||
// "github.com/edgebox-iot/edgeboxctl/internal/diagnostics"
|
||||
// "github.com/edgebox-iot/edgeboxctl/internal/utils"
|
||||
// "github.com/shirou/gopsutil/disk"
|
||||
// )
|
||||
|
||||
// Repository : Struct representing the backup repository of a device in the system
|
||||
type Repository struct {
|
||||
ID string `json:"id"`
|
||||
FileCount int64 `json:"file_count"`
|
||||
Size string `json:"size"`
|
||||
Snapshots []Snapshot `json:"snapshots"`
|
||||
Status string `json:"status"`
|
||||
// UsageStat UsageStat `json:"usage_stat"`
|
||||
}
|
||||
|
||||
// Snapshot : Struct representing a single snapshot in the backup repository
|
||||
type Snapshot struct {
|
||||
ID string `json:"id"`
|
||||
time string `json:"time"`
|
||||
}
|
||||
|
|
@ -1,7 +1,18 @@
|
|||
package diagnostics
|
||||
|
||||
type ReleaseVersion string
|
||||
|
||||
var Version string
|
||||
|
||||
var Commit string
|
||||
|
||||
var BuildDate string
|
||||
|
||||
const (
|
||||
DEV_VERSION ReleaseVersion = "dev"
|
||||
PROD_VERSION ReleaseVersion = "prod"
|
||||
CLOUD_VERSION ReleaseVersion = "cloud"
|
||||
OTHER_VERSION ReleaseVersion = "other"
|
||||
)
|
||||
|
||||
func GetReleaseVersion() ReleaseVersion {
|
||||
return ReleaseVersion(Version)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,10 +6,12 @@ import (
|
|||
"os"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
|
||||
"github.com/joho/godotenv"
|
||||
|
||||
"github.com/edgebox-iot/edgeboxctl/internal/system"
|
||||
"github.com/edgebox-iot/edgeboxctl/internal/utils"
|
||||
"github.com/edgebox-iot/edgeboxctl/internal/diagnostics"
|
||||
)
|
||||
|
||||
// EdgeApp : Struct representing an EdgeApp in the system
|
||||
|
|
@ -17,11 +19,15 @@ type EdgeApp struct {
|
|||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Description string `json:"description"`
|
||||
Experimental bool `json:"experimental"`
|
||||
Status EdgeAppStatus `json:"status"`
|
||||
Services []EdgeAppService `json:"services"`
|
||||
InternetAccessible bool `json:"internet_accessible"`
|
||||
NetworkURL string `json:"network_url"`
|
||||
InternetURL string `json:"internet_url"`
|
||||
Options []EdgeAppOption `json:"options"`
|
||||
NeedsConfig bool `json:"needs_config"`
|
||||
Login EdgeAppLogin `json:"login"`
|
||||
}
|
||||
|
||||
// MaybeEdgeApp : Boolean flag for validation of edgeapp existance
|
||||
|
|
@ -42,9 +48,30 @@ type EdgeAppService struct {
|
|||
IsRunning bool `json:"is_running"`
|
||||
}
|
||||
|
||||
type EdgeAppOption struct {
|
||||
Key string `json:"key"`
|
||||
Value string `json:"value"`
|
||||
DefaultValue string `json:"default_value"`
|
||||
Format string `json:"format"`
|
||||
Description string `json:"description"`
|
||||
IsSecret bool `json:"is_secret"`
|
||||
IsInstallLocked bool `json:"is_install_locked"`
|
||||
}
|
||||
|
||||
type EdgeAppLogin struct {
|
||||
Enabled bool `json:"enabled"`
|
||||
Username string `json:"username"`
|
||||
Password string `json:"password"`
|
||||
}
|
||||
|
||||
const configFilename = "/edgebox-compose.yml"
|
||||
const envFilename = "/edgebox.env"
|
||||
const optionsTemplateFilename = "/edgeapp.template.env"
|
||||
const optionsEnvFilename = "/edgeapp.env"
|
||||
const authEnvFilename = "/auth.env"
|
||||
const runnableFilename = "/.run"
|
||||
const appdataFoldername = "/appdata"
|
||||
const postInstallFilename = "/edgebox-postinstall.done"
|
||||
const myEdgeAppServiceEnvFilename = "/myedgeapp.env"
|
||||
const defaultContainerOperationSleepTime time.Duration = time.Second * 10
|
||||
|
||||
|
|
@ -56,14 +83,16 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
|
|||
Valid: false,
|
||||
}
|
||||
|
||||
_, err := os.Stat(utils.GetPath("edgeAppsPath") + ID + configFilename)
|
||||
_, err := os.Stat(utils.GetPath(utils.EdgeAppsPath) + ID + configFilename)
|
||||
if !os.IsNotExist(err) {
|
||||
// File exists. Start digging!
|
||||
|
||||
edgeAppName := ID
|
||||
edgeAppDescription := ""
|
||||
edgeAppExperimental := false
|
||||
edgeAppOptions := []EdgeAppOption{}
|
||||
|
||||
edgeAppEnv, err := godotenv.Read(utils.GetPath("edgeAppsPath") + ID + envFilename)
|
||||
edgeAppEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + envFilename)
|
||||
|
||||
if err != nil {
|
||||
log.Println("Error loading .env file for edgeapp " + edgeAppName)
|
||||
|
|
@ -74,12 +103,112 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
|
|||
if edgeAppEnv["EDGEAPP_DESCRIPTION"] != "" {
|
||||
edgeAppDescription = edgeAppEnv["EDGEAPP_DESCRIPTION"]
|
||||
}
|
||||
if edgeAppEnv["EDGEAPP_EXPERIMENTAL"] == "true" {
|
||||
edgeAppExperimental = true
|
||||
}
|
||||
}
|
||||
|
||||
needsConfig := false
|
||||
hasFilledOptions := false
|
||||
edgeAppOptionsTemplate, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + optionsTemplateFilename)
|
||||
if err != nil {
|
||||
log.Println("Error loading options template file for edgeapp " + edgeAppName)
|
||||
} else {
|
||||
// Try to read the edgeAppOptionsEnv file
|
||||
edgeAppOptionsEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + optionsEnvFilename)
|
||||
if err != nil {
|
||||
log.Println("Error loading options env file for edgeapp " + edgeAppName)
|
||||
} else {
|
||||
hasFilledOptions = true
|
||||
}
|
||||
|
||||
for key, value := range edgeAppOptionsTemplate {
|
||||
|
||||
optionFilledValue := ""
|
||||
if hasFilledOptions {
|
||||
// Check if key exists in edgeAppOptionsEnv
|
||||
optionFilledValue = edgeAppOptionsEnv[key]
|
||||
}
|
||||
|
||||
format := ""
|
||||
defaultValue := ""
|
||||
description := ""
|
||||
installLocked := false
|
||||
|
||||
// Parse value to separate by | and get the format, installLocked, description and default value
|
||||
// Format is the first element
|
||||
// InstallLocked is the second element
|
||||
// Description is the third element
|
||||
// Default value is the fourth element
|
||||
|
||||
valueSlices := strings.Split(value, "|")
|
||||
if len(valueSlices) > 0 {
|
||||
format = valueSlices[0]
|
||||
}
|
||||
if len(valueSlices) > 1 {
|
||||
installLocked = valueSlices[1] == "true"
|
||||
}
|
||||
if len(valueSlices) > 2 {
|
||||
description = valueSlices[2]
|
||||
}
|
||||
if len(valueSlices) > 3 {
|
||||
defaultValue = valueSlices[3]
|
||||
}
|
||||
|
||||
// // If value contains ">|", then get everything that is to the right of it as the description
|
||||
// // and get everything between "<>" as the format
|
||||
// if strings.Contains(value, ">|") {
|
||||
// description = strings.Split(value, ">|")[1]
|
||||
// // Check if description has default value. That would be everything that is to the right of the last "|"
|
||||
// if strings.Contains(description, "|") {
|
||||
// defaultValue = strings.Split(description, "|")[1]
|
||||
// description = strings.Split(description, "|")[0]
|
||||
// }
|
||||
|
||||
// value = strings.Split(value, ">|")[0]
|
||||
// // Remove the initial < from value
|
||||
// value = strings.TrimPrefix(value, "<")
|
||||
// } else {
|
||||
// // Trim initial < and final > from value
|
||||
// value = strings.TrimPrefix(value, "<")
|
||||
// value = strings.TrimSuffix(value, ">")
|
||||
// }
|
||||
|
||||
isSecret := false
|
||||
|
||||
// Check if the lowercased key string contains the letters "pass", "secret", "key"
|
||||
lowercaseKey := strings.ToLower(key)
|
||||
// check if lowercaseInput contains "pass", "key", or "secret", or "token"
|
||||
if strings.Contains(lowercaseKey, "pass") ||
|
||||
strings.Contains(lowercaseKey, "key") ||
|
||||
strings.Contains(lowercaseKey, "secret") ||
|
||||
strings.Contains(lowercaseKey, "token") {
|
||||
isSecret = true
|
||||
}
|
||||
|
||||
currentOption := EdgeAppOption{
|
||||
Key: key,
|
||||
Value: optionFilledValue,
|
||||
DefaultValue: defaultValue,
|
||||
Description: description,
|
||||
Format: format,
|
||||
IsSecret: isSecret,
|
||||
IsInstallLocked: installLocked,
|
||||
}
|
||||
edgeAppOptions = append(edgeAppOptions, currentOption)
|
||||
|
||||
if optionFilledValue == "" {
|
||||
needsConfig = true
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
edgeAppInternetAccessible := false
|
||||
edgeAppInternetURL := ""
|
||||
|
||||
myEdgeAppServiceEnv, err := godotenv.Read(utils.GetPath("edgeAppsPath") + ID + myEdgeAppServiceEnvFilename)
|
||||
myEdgeAppServiceEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + myEdgeAppServiceEnvFilename)
|
||||
if err != nil {
|
||||
log.Println("No myedge.app environment file found. Status is Network-Only")
|
||||
} else {
|
||||
|
|
@ -89,16 +218,36 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
|
|||
}
|
||||
}
|
||||
|
||||
edgeAppBasicAuthEnabled := false
|
||||
edgeAppBasicAuthUsername := ""
|
||||
edgeAppBasicAuthPassword := ""
|
||||
|
||||
edgeAppAuthEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + authEnvFilename)
|
||||
if err != nil {
|
||||
log.Println("No auth.env file found. Login status is disabled.")
|
||||
} else {
|
||||
if edgeAppAuthEnv["USERNAME"] != "" && edgeAppAuthEnv["PASSWORD"] != "" {
|
||||
edgeAppBasicAuthEnabled = true
|
||||
edgeAppBasicAuthUsername = edgeAppAuthEnv["USERNAME"]
|
||||
edgeAppBasicAuthPassword = edgeAppAuthEnv["PASSWORD"]
|
||||
}
|
||||
}
|
||||
|
||||
result = MaybeEdgeApp{
|
||||
EdgeApp: EdgeApp{
|
||||
ID: ID,
|
||||
Name: edgeAppName,
|
||||
Description: edgeAppDescription,
|
||||
Experimental: edgeAppExperimental,
|
||||
Status: GetEdgeAppStatus(ID),
|
||||
Services: GetEdgeAppServices(ID),
|
||||
InternetAccessible: edgeAppInternetAccessible,
|
||||
NetworkURL: ID + ".edgebox.local",
|
||||
NetworkURL: ID + "." + system.GetHostname() + ".local",
|
||||
InternetURL: edgeAppInternetURL,
|
||||
Options: edgeAppOptions,
|
||||
NeedsConfig: needsConfig,
|
||||
Login: EdgeAppLogin{edgeAppBasicAuthEnabled, edgeAppBasicAuthUsername, edgeAppBasicAuthPassword},
|
||||
|
||||
},
|
||||
Valid: true,
|
||||
}
|
||||
|
|
@ -113,7 +262,7 @@ func IsEdgeAppInstalled(ID string) bool {
|
|||
|
||||
result := false
|
||||
|
||||
_, err := os.Stat(utils.GetPath("edgeAppsPath") + ID + runnableFilename)
|
||||
_, err := os.Stat(utils.GetPath(utils.EdgeAppsPath) + ID + runnableFilename)
|
||||
if !os.IsNotExist(err) {
|
||||
result = true
|
||||
}
|
||||
|
|
@ -122,21 +271,54 @@ func IsEdgeAppInstalled(ID string) bool {
|
|||
|
||||
}
|
||||
|
||||
func writeAppRunnableFiles(ID string) bool {
|
||||
edgeAppPath := utils.GetPath(utils.EdgeAppsPath)
|
||||
_, err := os.Stat(edgeAppPath + ID + runnableFilename)
|
||||
if os.IsNotExist(err) {
|
||||
_, err := os.Create(edgeAppPath + ID + runnableFilename)
|
||||
if err != nil {
|
||||
log.Fatal("Runnable file for EdgeApp could not be created!")
|
||||
return false
|
||||
}
|
||||
|
||||
// Check the block default apps option
|
||||
blockDefaultAppsOption := utils.ReadOption("DASHBOARD_BLOCK_DEFAULT_APPS_PUBLIC_ACCESS")
|
||||
if blockDefaultAppsOption != "yes" {
|
||||
// Create myedgeapp.env file with default network URL
|
||||
envFilePath := edgeAppPath + ID + myEdgeAppServiceEnvFilename
|
||||
|
||||
var networkURL string
|
||||
domainName := utils.ReadOption("DOMAIN_NAME")
|
||||
|
||||
if domainName != "" {
|
||||
networkURL = ID + "." + domainName
|
||||
} else if diagnostics.GetReleaseVersion() == diagnostics.CLOUD_VERSION {
|
||||
cluster := utils.ReadOption("CLUSTER")
|
||||
username := utils.ReadOption("USERNAME")
|
||||
if cluster != "" && username != "" {
|
||||
networkURL = username + "-" + ID + "." + cluster
|
||||
}
|
||||
} else {
|
||||
networkURL = ID + "." + system.GetHostname() + ".local" // default
|
||||
}
|
||||
|
||||
env, _ := godotenv.Unmarshal("INTERNET_URL=" + networkURL)
|
||||
err = godotenv.Write(env, envFilePath)
|
||||
if err != nil {
|
||||
log.Printf("Error creating myedgeapp.env file: %s", err)
|
||||
// result = false
|
||||
}
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func SetEdgeAppInstalled(ID string) bool {
|
||||
|
||||
result := true
|
||||
|
||||
_, err := os.Stat(utils.GetPath("edgeAppsPath") + ID + runnableFilename)
|
||||
if os.IsNotExist(err) {
|
||||
|
||||
_, err := os.Create(utils.GetPath("edgeAppsPath") + ID + runnableFilename)
|
||||
result = true
|
||||
|
||||
if err != nil {
|
||||
log.Fatal("Runnable file for EdgeApp could not be created!")
|
||||
result = false
|
||||
}
|
||||
|
||||
if writeAppRunnableFiles(ID) {
|
||||
|
||||
buildFrameworkContainers()
|
||||
|
||||
} else {
|
||||
|
|
@ -150,13 +332,63 @@ func SetEdgeAppInstalled(ID string) bool {
|
|||
|
||||
}
|
||||
|
||||
func SetEdgeAppNotInstalled(ID string) bool {
|
||||
func SetEdgeAppBulkInstalled(IDs []string) bool {
|
||||
|
||||
result := true
|
||||
err := os.Remove(utils.GetPath("edgeAppsPath") + ID + runnableFilename)
|
||||
|
||||
for _, ID := range IDs {
|
||||
writeAppRunnableFiles(ID)
|
||||
}
|
||||
|
||||
buildFrameworkContainers()
|
||||
|
||||
return result
|
||||
|
||||
}
|
||||
|
||||
|
||||
func SetEdgeAppNotInstalled(ID string) bool {
|
||||
|
||||
// Stop the app first
|
||||
StopEdgeApp(ID)
|
||||
|
||||
// Now remove any files
|
||||
result := true
|
||||
|
||||
err := os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + runnableFilename)
|
||||
if err != nil {
|
||||
result = false
|
||||
log.Fatal(err)
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + authEnvFilename)
|
||||
if err != nil {
|
||||
result = false
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
err = os.RemoveAll(utils.GetPath(utils.EdgeAppsPath) + ID + appdataFoldername)
|
||||
if err != nil {
|
||||
result = false
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + myEdgeAppServiceEnvFilename)
|
||||
if err != nil {
|
||||
result = false
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + optionsEnvFilename)
|
||||
if err != nil {
|
||||
result = false
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + postInstallFilename)
|
||||
if err != nil {
|
||||
result = false
|
||||
log.Println(err)
|
||||
}
|
||||
|
||||
buildFrameworkContainers()
|
||||
|
|
@ -172,7 +404,7 @@ func GetEdgeApps() []EdgeApp {
|
|||
|
||||
// Building list of available edgeapps in the system with their status
|
||||
|
||||
files, err := ioutil.ReadDir(utils.GetPath("edgeAppsPath"))
|
||||
files, err := ioutil.ReadDir(utils.GetPath(utils.EdgeAppsPath))
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
|
@ -237,20 +469,32 @@ func GetEdgeAppStatus(ID string) EdgeAppStatus {
|
|||
|
||||
// GetEdgeAppServices : Returns a
|
||||
func GetEdgeAppServices(ID string) []EdgeAppService {
|
||||
|
||||
cmdArgs := []string{"-r", ".services | keys[]", utils.GetPath("edgeAppsPath") + ID + configFilename}
|
||||
servicesString := utils.Exec(utils.GetPath("wsPath"), "yq", cmdArgs)
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
cmdArgs := []string{"-r", ".services | keys[]", utils.GetPath(utils.EdgeAppsPath) + ID + configFilename}
|
||||
servicesString := utils.Exec(utils.GetPath(utils.WsPath), "yq", cmdArgs)
|
||||
serviceSlices := strings.Split(servicesString, "\n")
|
||||
serviceSlices = utils.DeleteEmptySlices(serviceSlices)
|
||||
var edgeAppServices []EdgeAppService
|
||||
|
||||
for _, serviceID := range serviceSlices {
|
||||
cmdArgs = []string{"-f", utils.GetPath("wsPath") + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"}
|
||||
cmdResult := utils.Exec(utils.GetPath("wsPath"), "docker-compose", cmdArgs)
|
||||
shouldBeRunning := false
|
||||
isRunning := false
|
||||
if cmdResult != "" {
|
||||
isRunning = true
|
||||
|
||||
// Is service "runnable" when .run lockfile in the app folder
|
||||
_, err := os.Stat(utils.GetPath(utils.EdgeAppsPath) + ID + runnableFilename)
|
||||
if !os.IsNotExist(err) {
|
||||
shouldBeRunning = true
|
||||
}
|
||||
|
||||
// Check if the service is actually running
|
||||
if shouldBeRunning {
|
||||
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"}
|
||||
cmdResult := utils.Exec(wsPath, "docker-compose", cmdArgs)
|
||||
if cmdResult != "" {
|
||||
isRunning = true
|
||||
}
|
||||
}
|
||||
|
||||
edgeAppServices = append(edgeAppServices, EdgeAppService{ID: serviceID, IsRunning: isRunning})
|
||||
}
|
||||
|
||||
|
|
@ -260,16 +504,14 @@ func GetEdgeAppServices(ID string) []EdgeAppService {
|
|||
|
||||
// RunEdgeApp : Run an EdgeApp and return its most current status
|
||||
func RunEdgeApp(ID string) EdgeAppStatus {
|
||||
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
services := GetEdgeAppServices(ID)
|
||||
|
||||
cmdArgs := []string{}
|
||||
|
||||
for _, service := range services {
|
||||
|
||||
cmdArgs = []string{"-f", utils.GetPath("wsPath") + "/docker-compose.yml", "start", service.ID}
|
||||
utils.Exec(utils.GetPath("wsPath"), "docker-compose", cmdArgs)
|
||||
|
||||
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "start", service.ID}
|
||||
utils.Exec(wsPath, "docker-compose", cmdArgs)
|
||||
}
|
||||
|
||||
// Wait for it to settle up before continuing...
|
||||
|
|
@ -281,16 +523,13 @@ func RunEdgeApp(ID string) EdgeAppStatus {
|
|||
|
||||
// StopEdgeApp : Stops an EdgeApp and return its most current status
|
||||
func StopEdgeApp(ID string) EdgeAppStatus {
|
||||
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
services := GetEdgeAppServices(ID)
|
||||
|
||||
cmdArgs := []string{}
|
||||
|
||||
for _, service := range services {
|
||||
|
||||
cmdArgs = []string{"-f", utils.GetPath("wsPath") + "/docker-compose.yml", "stop", service.ID}
|
||||
utils.Exec(utils.GetPath("wsPath"), "docker-compose", cmdArgs)
|
||||
|
||||
cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "stop", service.ID}
|
||||
utils.Exec(wsPath, "docker-compose", cmdArgs)
|
||||
}
|
||||
|
||||
// Wait for it to settle up before continuing...
|
||||
|
|
@ -300,13 +539,43 @@ func StopEdgeApp(ID string) EdgeAppStatus {
|
|||
|
||||
}
|
||||
|
||||
// StopAllEdgeApps: Stops all EdgeApps and returns a count of how many were stopped
|
||||
func StopAllEdgeApps() int {
|
||||
edgeApps := GetEdgeApps()
|
||||
appCount := 0
|
||||
for _, edgeApp := range edgeApps {
|
||||
StopEdgeApp(edgeApp.ID)
|
||||
appCount++
|
||||
}
|
||||
|
||||
return appCount
|
||||
|
||||
}
|
||||
|
||||
// StartAllEdgeApps: Starts all EdgeApps and returns a count of how many were started
|
||||
func StartAllEdgeApps() int {
|
||||
edgeApps := GetEdgeApps()
|
||||
appCount := 0
|
||||
for _, edgeApp := range edgeApps {
|
||||
RunEdgeApp(edgeApp.ID)
|
||||
appCount++
|
||||
}
|
||||
|
||||
return appCount
|
||||
|
||||
}
|
||||
|
||||
func RestartEdgeAppsService() {
|
||||
buildFrameworkContainers()
|
||||
}
|
||||
|
||||
// EnableOnline : Write environment file and rebuild the necessary containers. Rebuilds containers in project (in case of change only)
|
||||
func EnableOnline(ID string, InternetURL string) MaybeEdgeApp {
|
||||
|
||||
maybeEdgeApp := GetEdgeApp(ID)
|
||||
if maybeEdgeApp.Valid { // We're only going to do this operation if the EdgeApp actually exists.
|
||||
// Create the myedgeapp.env file and add the InternetURL entry to it
|
||||
envFilePath := utils.GetPath("edgeAppsPath") + ID + myEdgeAppServiceEnvFilename
|
||||
envFilePath := utils.GetPath(utils.EdgeAppsPath) + ID + myEdgeAppServiceEnvFilename
|
||||
env, _ := godotenv.Unmarshal("INTERNET_URL=" + InternetURL)
|
||||
_ = godotenv.Write(env, envFilePath)
|
||||
}
|
||||
|
|
@ -320,13 +589,13 @@ func EnableOnline(ID string, InternetURL string) MaybeEdgeApp {
|
|||
// DisableOnline : Removes env files necessary for system external access config. Rebuilds containers in project (in case of change only).
|
||||
func DisableOnline(ID string) MaybeEdgeApp {
|
||||
|
||||
envFilePath := utils.GetPath("edgeAppsPath") + ID + myEdgeAppServiceEnvFilename
|
||||
envFilePath := utils.GetPath(utils.EdgeAppsPath) + ID + myEdgeAppServiceEnvFilename
|
||||
_, err := godotenv.Read(envFilePath)
|
||||
if err != nil {
|
||||
log.Println("myedge.app environment file for " + ID + " not found. No need to delete.")
|
||||
} else {
|
||||
cmdArgs := []string{envFilePath}
|
||||
utils.Exec(utils.GetPath("wsPath"), "rm", cmdArgs)
|
||||
utils.Exec(utils.GetPath(utils.WsPath), "rm", cmdArgs)
|
||||
}
|
||||
|
||||
buildFrameworkContainers()
|
||||
|
|
@ -335,10 +604,42 @@ func DisableOnline(ID string) MaybeEdgeApp {
|
|||
|
||||
}
|
||||
|
||||
func EnablePublicDashboard(InternetURL string) bool {
|
||||
|
||||
envFilePath := utils.GetPath(utils.ApiPath) + myEdgeAppServiceEnvFilename
|
||||
env, _ := godotenv.Unmarshal("INTERNET_URL=" + InternetURL)
|
||||
_ = godotenv.Write(env, envFilePath)
|
||||
|
||||
buildFrameworkContainers()
|
||||
|
||||
return true
|
||||
|
||||
}
|
||||
|
||||
func DisablePublicDashboard() bool {
|
||||
envFilePath := utils.GetPath(utils.ApiPath) + myEdgeAppServiceEnvFilename
|
||||
if !IsPublicDashboard() {
|
||||
log.Println("myedge.app environment file for the dashboard / api not found. No need to delete.")
|
||||
return false
|
||||
}
|
||||
|
||||
cmdArgs := []string{envFilePath}
|
||||
utils.Exec(utils.GetPath(utils.ApiPath), "rm", cmdArgs)
|
||||
buildFrameworkContainers()
|
||||
return true
|
||||
}
|
||||
|
||||
func IsPublicDashboard() bool {
|
||||
envFilePath := utils.GetPath(utils.ApiPath) + myEdgeAppServiceEnvFilename
|
||||
_, err := godotenv.Read(envFilePath)
|
||||
return err == nil
|
||||
}
|
||||
|
||||
func buildFrameworkContainers() {
|
||||
|
||||
cmdArgs := []string{utils.GetPath("wsPath") + "ws", "--build"}
|
||||
utils.ExecAndStream(utils.GetPath("wsPath"), "sh", cmdArgs)
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
cmdArgs := []string{wsPath + "ws", "--build"}
|
||||
utils.ExecAndStream(wsPath, "sh", cmdArgs)
|
||||
|
||||
time.Sleep(defaultContainerOperationSleepTime)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,28 +2,30 @@ package storage
|
|||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/edgebox-iot/edgeboxctl/internal/diagnostics"
|
||||
"github.com/edgebox-iot/edgeboxctl/internal/utils"
|
||||
"github.com/shirou/gopsutil/disk"
|
||||
)
|
||||
|
||||
// Device : Struct representing a storage device in the system
|
||||
type Device struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Size string `json:"size"`
|
||||
InUse bool `json:"in_use"`
|
||||
MainDevice bool `json:"main_device"`
|
||||
MAJ string `json:"maj"`
|
||||
MIN string `json:"min"`
|
||||
RM string `json:"rm"`
|
||||
RO string `json:"ro"`
|
||||
Partitions []Partition `json:"partitions"`
|
||||
Status DeviceStatus `json:"status"`
|
||||
UsageStat UsageStat `json:"usage_stat"`
|
||||
ID DeviceIdentifier `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Size string `json:"size"`
|
||||
InUse bool `json:"in_use"`
|
||||
MainDevice bool `json:"main_device"`
|
||||
MAJ string `json:"maj"`
|
||||
MIN string `json:"min"`
|
||||
RM string `json:"rm"`
|
||||
RO string `json:"ro"`
|
||||
Partitions []Partition `json:"partitions"`
|
||||
Status DeviceStatus `json:"status"`
|
||||
UsageStat UsageStat `json:"usage_stat"`
|
||||
}
|
||||
|
||||
// DeviceStatus : Struct representing possible storage device statuses (code + description)
|
||||
|
|
@ -66,10 +68,28 @@ type Partition struct {
|
|||
UsageStat UsageStat `json:"usage_stat"`
|
||||
}
|
||||
|
||||
const mainDiskID = "mmcblk0"
|
||||
type DeviceIdentifier string
|
||||
|
||||
const (
|
||||
DISK_TYPE_SDA DeviceIdentifier = "sda"
|
||||
DISK_TYPE_MCBLK DeviceIdentifier = "mmcblk0"
|
||||
DISK_TYPE_VDA DeviceIdentifier = "vda"
|
||||
MIN_DISK_SIZE int = 1048576 // 1GB in bytes
|
||||
)
|
||||
|
||||
func GetDeviceIdentifier(release_version diagnostics.ReleaseVersion) DeviceIdentifier {
|
||||
switch release_version {
|
||||
case diagnostics.CLOUD_VERSION:
|
||||
return DISK_TYPE_SDA
|
||||
case diagnostics.PROD_VERSION:
|
||||
return DISK_TYPE_MCBLK
|
||||
}
|
||||
|
||||
return DISK_TYPE_SDA
|
||||
}
|
||||
|
||||
// GetDevices : Returns a list of all available sotrage devices in structs filled with information
|
||||
func GetDevices() []Device {
|
||||
func GetDevices(release_version diagnostics.ReleaseVersion) []Device {
|
||||
|
||||
var devices []Device
|
||||
|
||||
|
|
@ -82,6 +102,8 @@ func GetDevices() []Device {
|
|||
firstDevice := true
|
||||
currentDeviceInUseFlag := false
|
||||
|
||||
mainDiskID := GetDeviceIdentifier(release_version)
|
||||
|
||||
for scanner.Scan() {
|
||||
// 1 Device is represented here. Extract words in order for filling a Device struct
|
||||
// Example deviceRawInfo: "mmcblk0 179:0 0 29.7G 0 disk"
|
||||
|
|
@ -114,7 +136,13 @@ func GetDevices() []Device {
|
|||
currentDevice.InUse = currentDeviceInUseFlag
|
||||
currentDeviceInUseFlag = false
|
||||
currentPartitions = []Partition{}
|
||||
devices = append(devices, currentDevice)
|
||||
size, err := strconv.Atoi(currentDevice.Size)
|
||||
if err != nil {
|
||||
size = 0
|
||||
}
|
||||
if size > MIN_DISK_SIZE {
|
||||
devices = append(devices, currentDevice)
|
||||
}
|
||||
} else {
|
||||
firstDevice = false
|
||||
}
|
||||
|
|
@ -122,7 +150,7 @@ func GetDevices() []Device {
|
|||
mainDevice := false
|
||||
|
||||
device := Device{
|
||||
ID: deviceRawInfo[0],
|
||||
ID: DeviceIdentifier(deviceRawInfo[0]),
|
||||
Name: deviceRawInfo[0],
|
||||
Size: deviceRawInfo[3],
|
||||
MainDevice: mainDevice,
|
||||
|
|
@ -173,8 +201,22 @@ func GetDevices() []Device {
|
|||
currentDevice.Status.Description = "Not configured"
|
||||
}
|
||||
currentDevice.InUse = currentDeviceInUseFlag
|
||||
devices = append([]Device{currentDevice}, devices...) // Prepending the first device...
|
||||
|
||||
fmt.Println("Secondary Storage Devices Found: ", len(devices))
|
||||
fmt.Println("Main Storage Device size: ", currentDevice.Size)
|
||||
|
||||
// only append device if size > 1GB
|
||||
if currentDevice.Size != "" && currentDevice.Size != "0" {
|
||||
// Convert size to int
|
||||
// Convert string to int
|
||||
size, err := strconv.Atoi(currentDevice.Size)
|
||||
if err != nil {
|
||||
size = 0
|
||||
}
|
||||
if size > MIN_DISK_SIZE {
|
||||
devices = append([]Device{currentDevice}, devices...) // Prepending the first device...
|
||||
}
|
||||
}
|
||||
devices = getDevicesSpaceUsage(devices)
|
||||
|
||||
return devices
|
||||
|
|
@ -204,9 +246,9 @@ func getDevicesSpaceUsage(devices []Device) []Device {
|
|||
bucketsUsageSplit := (uint64)(0)
|
||||
othersUsageSplit := (uint64)(0)
|
||||
|
||||
edgeappsDirSize, _ := getDirSize(utils.GetPath("edgeAppsPath"))
|
||||
edgeappsDirSize, _ := getDirSize(utils.GetPath(utils.EdgeAppsPath))
|
||||
// TODO for later: Figure out to get correct paths for each partition...
|
||||
wsAppDataDirSize, _ := getDirSize("/home/system/components/ws/appdata")
|
||||
wsAppDataDirSize, _ := getDirSize(utils.GetPath(utils.WsPath) + "/appdata")
|
||||
|
||||
if partition.Mountpoint == "/" {
|
||||
edgeappsUsageSplit = edgeappsDirSize + wsAppDataDirSize
|
||||
|
|
|
|||
|
|
@ -7,25 +7,37 @@ import (
|
|||
)
|
||||
|
||||
func TestGetDevices(t *testing.T) {
|
||||
result := GetDevices()
|
||||
|
||||
if len(result) == 0 {
|
||||
t.Log("Testing with release version dev")
|
||||
assertGetDevices(GetDevices("dev"), t)
|
||||
t.Log("Testing with release version prod")
|
||||
assertGetDevices(GetDevices("prod"), t)
|
||||
t.Log("Testing with release version cloud")
|
||||
assertGetDevices(GetDevices("cloud"), t)
|
||||
|
||||
}
|
||||
|
||||
func assertGetDevices(devices []Device, t *testing.T) {
|
||||
|
||||
if len(devices) == 0 {
|
||||
t.Log("Expecting at least 1 block device, 0 elements found in slice")
|
||||
t.Fail()
|
||||
}
|
||||
|
||||
foundDevice := false
|
||||
|
||||
t.Log("Looking for a mmcblk0 or sda device")
|
||||
for _, device := range result {
|
||||
if device.ID == "mmcblk0" || device.ID == "sda" {
|
||||
t.Log("Looking for a mmcblk0, sda or dva device")
|
||||
for _, device := range devices {
|
||||
|
||||
if device.ID == "mmcblk0" || device.ID == "sda" || device.ID == "vda" {
|
||||
t.Log("Found target device", device.ID)
|
||||
foundDevice = true
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if !foundDevice {
|
||||
t.Log("Expected to find device mmcblk0 but did not. Devices:", result)
|
||||
t.Log("Expected to find device mmcblk0, sda or dva but did not. Devices:", devices)
|
||||
t.Fail()
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,16 +3,38 @@ package system
|
|||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
"log"
|
||||
"os"
|
||||
"io"
|
||||
"errors"
|
||||
"os/exec"
|
||||
"bufio"
|
||||
"path/filepath"
|
||||
"io/ioutil"
|
||||
"encoding/json"
|
||||
|
||||
"github.com/edgebox-iot/edgeboxctl/internal/utils"
|
||||
|
||||
"github.com/joho/godotenv"
|
||||
"github.com/shirou/gopsutil/host"
|
||||
"github.com/go-yaml/yaml"
|
||||
)
|
||||
|
||||
type cloudflaredTunnelJson struct {
|
||||
AccountTag string `json:"AccountTag"`
|
||||
TunnelSecret string `json:"TunnelSecret"`
|
||||
TunnelID string `json:"TunnelID"`
|
||||
}
|
||||
|
||||
// GetUptimeInSeconds: Returns a value (as string) of the total system uptime
|
||||
func GetUptimeInSeconds() string {
|
||||
uptime, _ := host.Uptime()
|
||||
|
||||
return strconv.FormatUint(uptime, 10)
|
||||
}
|
||||
|
||||
// GetUptimeFormatted: Returns a humanized version that can be useful for logging
|
||||
func GetUptimeFormatted() string {
|
||||
uptime, _ := host.Uptime()
|
||||
|
||||
|
|
@ -21,3 +43,558 @@ func GetUptimeFormatted() string {
|
|||
minutes := ((uptime - (days * 60 * 60 * 24)) - (hours * 60 * 60)) / 60
|
||||
return fmt.Sprintf("%d days, %d hours, %d minutes", days, hours, minutes)
|
||||
}
|
||||
|
||||
// GetIP: Returns the ip address of the instance
|
||||
func GetIP() string {
|
||||
ip := ""
|
||||
|
||||
// Trying to find a valid IP (For direct connection, not tunneled)
|
||||
ethResult := utils.ExecAndGetLines("/", "ip", []string{"-o", "-4", "addr", "list", "eth0"})
|
||||
for ethResult.Scan() {
|
||||
adapterRawInfo := strings.Fields(ethResult.Text())
|
||||
if ip == "" {
|
||||
ip = strings.Split(adapterRawInfo[3], "/")[0]
|
||||
}
|
||||
}
|
||||
|
||||
// If no IP was found yet, try wlan0
|
||||
if ip == "" {
|
||||
wlanResult := utils.ExecAndGetLines("/", "ip", []string{"-o", "-4", "addr", "list", "wlan0"})
|
||||
for wlanResult.Scan() {
|
||||
adapterRawInfo := strings.Fields(wlanResult.Text())
|
||||
if ip == "" {
|
||||
ip = strings.Split(adapterRawInfo[3], "/")[0]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return ip
|
||||
}
|
||||
|
||||
func GetHostname() string {
|
||||
return utils.Exec("/", "hostname", []string{})
|
||||
}
|
||||
|
||||
// SetupCloudOptions: Reads the designated env file looking for options to write into the options table. Meant to be used on initial setup. Deletes source env file after operation.
|
||||
func SetupCloudOptions() {
|
||||
|
||||
var cloudEnv map[string]string
|
||||
cloudEnvFileLocationPath := utils.GetPath(utils.CloudEnvFileLocation)
|
||||
cloudEnv, err := godotenv.Read(cloudEnvFileLocationPath)
|
||||
|
||||
if err != nil {
|
||||
fmt.Println("Error loading .env file for cloud version setup")
|
||||
}
|
||||
|
||||
if cloudEnv["NAME"] != "" {
|
||||
utils.WriteOption("NAME", cloudEnv["NAME"])
|
||||
}
|
||||
|
||||
if cloudEnv["EMAIL"] != "" {
|
||||
utils.WriteOption("EMAIL", cloudEnv["EMAIL"])
|
||||
}
|
||||
|
||||
if cloudEnv["USERNAME"] != "" {
|
||||
utils.WriteOption("USERNAME", cloudEnv["USERNAME"])
|
||||
}
|
||||
|
||||
if cloudEnv["CLUSTER"] != "" {
|
||||
utils.WriteOption("CLUSTER", cloudEnv["CLUSTER"])
|
||||
}
|
||||
|
||||
if cloudEnv["CLUSTER_IP"] != "" {
|
||||
utils.WriteOption("CLUSTER_IP", cloudEnv["CLUSTER_IP"])
|
||||
}
|
||||
|
||||
if cloudEnv["CLUSTER_SSH_PORT"] != "" {
|
||||
utils.WriteOption("CLUSTER_SSH_PORT", cloudEnv["CLUSTER_SSH_PORT"])
|
||||
}
|
||||
|
||||
if cloudEnv["EDGEBOXIO_API_TOKEN"] != "" {
|
||||
utils.WriteOption("EDGEBOXIO_API_TOKEN", cloudEnv["EDGEBOXIO_API_TOKEN"])
|
||||
}
|
||||
|
||||
// In the end of this operation takes place, remove the env file as to not overwrite any options once they are set.
|
||||
utils.Exec("/", "rm", []string{cloudEnvFileLocationPath})
|
||||
}
|
||||
|
||||
func StartSystemLogger() {
|
||||
fmt.Println("Starting system logger")
|
||||
loggerPath := utils.GetPath(utils.LoggerPath)
|
||||
utils.Exec(loggerPath, "make", []string{"start"})
|
||||
}
|
||||
|
||||
// UpdateSystemLoggerServices: Updates the services.txt file with the services that are currently running
|
||||
func UpdateSystemLoggerServices(services []string) {
|
||||
fmt.Println("Updating system logger services:")
|
||||
fmt.Println(services)
|
||||
loggerPath := utils.GetPath(utils.LoggerPath)
|
||||
|
||||
utils.Exec(loggerPath, "bash", []string{"-c", "rm services.txt && touch services.txt"})
|
||||
|
||||
for _, service := range services {
|
||||
fmt.Println("Adding " + service + " to services.txt")
|
||||
utils.Exec(loggerPath, "bash", []string{"-c", "echo " + service + " >> services.txt"})
|
||||
}
|
||||
|
||||
// Add empty line at the end of file (best practice)
|
||||
utils.Exec(loggerPath, "bash", []string{"-c", "echo '' >> services.txt"})
|
||||
}
|
||||
|
||||
// StartWs: Starts the webserver service for Edgeapps
|
||||
func StartWs() {
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
fmt.Println("Starting WS")
|
||||
cmdargs := []string{"-b"}
|
||||
utils.Exec(wsPath, "./ws", cmdargs)
|
||||
}
|
||||
|
||||
// StartService: Starts a service
|
||||
func StartService(serviceID string) {
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
fmt.Println("Starting" + serviceID + "service")
|
||||
cmdargs := []string{"start", serviceID}
|
||||
utils.Exec(wsPath, "systemctl", cmdargs)
|
||||
}
|
||||
|
||||
// StopService: Stops a service
|
||||
func StopService(serviceID string) {
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
fmt.Println("Stopping" + serviceID + "service")
|
||||
cmdargs := []string{"stop", "cloudflared"}
|
||||
utils.Exec(wsPath, "systemctl", cmdargs)
|
||||
}
|
||||
|
||||
// RestartService: Restarts a service
|
||||
func RestartService(serviceID string) {
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
fmt.Println("Restarting" + serviceID + "service")
|
||||
cmdargs := []string{"restart", serviceID}
|
||||
utils.Exec(wsPath, "systemctl", cmdargs)
|
||||
}
|
||||
|
||||
// GetServiceStatus: Returns the status output of a service
|
||||
func GetServiceStatus(serviceID string) string {
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
cmdargs := []string{"status", serviceID}
|
||||
return utils.Exec(wsPath, "systemctl", cmdargs)
|
||||
}
|
||||
|
||||
func CreateBackupsPasswordFile(password string) {
|
||||
// Create a password file for backups
|
||||
backupPasswordFile := utils.GetPath(utils.BackupPasswordFileLocation)
|
||||
backupPasswordFileDir := filepath.Dir(backupPasswordFile)
|
||||
|
||||
if _, err := os.Stat(backupPasswordFileDir); os.IsNotExist(err) {
|
||||
os.MkdirAll(backupPasswordFileDir, 0755)
|
||||
}
|
||||
|
||||
// Write the password to the file, overriting an existing file
|
||||
err := ioutil.WriteFile(backupPasswordFile, []byte(password), 0644)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
|
||||
// CreateTunnel: Creates a tunnel via cloudflared, needs to be authenticated first
|
||||
func CreateTunnel(configDestination string) {
|
||||
fmt.Println("Creating Tunnel for Edgebox.")
|
||||
cmd := exec.Command("sh", "/home/system/components/edgeboxctl/scripts/cloudflared_tunnel_create.sh")
|
||||
stdout, err := cmd.StdoutPipe()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
scanner := bufio.NewScanner(stdout)
|
||||
err = cmd.Start()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
for scanner.Scan() {
|
||||
fmt.Println(scanner.Text())
|
||||
text := scanner.Text()
|
||||
fmt.Println(text)
|
||||
}
|
||||
if scanner.Err() != nil {
|
||||
cmd.Process.Kill()
|
||||
cmd.Wait()
|
||||
panic(scanner.Err())
|
||||
}
|
||||
|
||||
// This also needs to be executed in root and non root variants
|
||||
fmt.Println("Reading cloudflared folder to get the JSON file.")
|
||||
isRoot := false
|
||||
dir := "/home/system/.cloudflared/"
|
||||
dir2 := "/root/.cloudflared/"
|
||||
files, err := os.ReadDir(dir)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
var jsonFile os.DirEntry
|
||||
for _, file := range files {
|
||||
// check if file has json extension
|
||||
if filepath.Ext(file.Name()) == ".json" {
|
||||
fmt.Println("Non-Root JSON file found: " + file.Name())
|
||||
jsonFile = file
|
||||
}
|
||||
}
|
||||
|
||||
// If the files are not in the home folder, try the root folder
|
||||
if jsonFile == nil {
|
||||
files, err = os.ReadDir(dir2)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
for _, file := range files {
|
||||
// check if file has json extension
|
||||
if filepath.Ext(file.Name()) == ".json" {
|
||||
fmt.Println("Root JSON file found: " + file.Name())
|
||||
jsonFile = file
|
||||
isRoot = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if jsonFile == nil {
|
||||
panic("No JSON file found in directory")
|
||||
}
|
||||
|
||||
fmt.Println("Reading JSON file.")
|
||||
targetDir := "/home/system/.cloudflared/"
|
||||
if isRoot {
|
||||
targetDir = "/root/.cloudflared/"
|
||||
}
|
||||
|
||||
jsonFilePath := filepath.Join(targetDir, jsonFile.Name())
|
||||
jsonBytes, err := ioutil.ReadFile(jsonFilePath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
fmt.Println("Parsing JSON file.")
|
||||
var data cloudflaredTunnelJson
|
||||
err = json.Unmarshal(jsonBytes, &data)
|
||||
if err != nil {
|
||||
log.Printf("Error reading tunnel JSON file: %s", err)
|
||||
}
|
||||
|
||||
fmt.Println("Tunnel ID is:" + data.TunnelID)
|
||||
|
||||
// create the config.yml file with the following content in each line:
|
||||
// "url": "http://localhost:80"
|
||||
// "tunnel": "<TunnelID>"
|
||||
// "credentials-file": "/root/.cloudflared/<tunnelID>.json"
|
||||
|
||||
file := configDestination
|
||||
f, err := os.Create(file)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
defer f.Close()
|
||||
|
||||
_, err = f.WriteString("url: http://localhost:80\ntunnel: " + data.TunnelID + "\ncredentials-file: " + jsonFilePath)
|
||||
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
|
||||
// DeleteTunnel: Deletes a tunnel via cloudflared, this does not remove the service
|
||||
func DeleteTunnel() {
|
||||
fmt.Println("Deleting possible previous tunnel.")
|
||||
|
||||
// Configure the service and start it
|
||||
cmd := exec.Command("sh", "/home/system/components/edgeboxctl/scripts/cloudflared_tunnel_delete.sh")
|
||||
stdout, err := cmd.StdoutPipe()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
scanner := bufio.NewScanner(stdout)
|
||||
err = cmd.Start()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
for scanner.Scan() {
|
||||
fmt.Println(scanner.Text())
|
||||
text := scanner.Text()
|
||||
fmt.Println(text)
|
||||
}
|
||||
if scanner.Err() != nil {
|
||||
cmd.Process.Kill()
|
||||
cmd.Wait()
|
||||
panic(scanner.Err())
|
||||
}
|
||||
}
|
||||
|
||||
// InstallTunnelService: Installs the tunnel service
|
||||
func InstallTunnelService(config string) {
|
||||
fmt.Println("Installing cloudflared service.")
|
||||
cmd := exec.Command("cloudflared", "--config", config, "service", "install")
|
||||
cmd.Start()
|
||||
cmd.Wait()
|
||||
}
|
||||
|
||||
// RemoveTunnelService: Removes the tunnel service
|
||||
func RemoveTunnelService() {
|
||||
wsPath := utils.GetPath(utils.WsPath)
|
||||
fmt.Println("Removing possibly previous service install.")
|
||||
cmd := exec.Command("cloudflared", "service", "uninstall")
|
||||
cmd.Start()
|
||||
cmd.Wait()
|
||||
|
||||
fmt.Println("Removing cloudflared files")
|
||||
cmdargs := []string{"-rf", "/home/system/.cloudflared"}
|
||||
utils.Exec(wsPath, "rm", cmdargs)
|
||||
cmdargs = []string{"-rf", "/etc/cloudflared/config.yml"}
|
||||
utils.Exec(wsPath, "rm", cmdargs)
|
||||
cmdargs = []string{"-rf", "/root/.cloudflared/cert.pem"}
|
||||
utils.Exec(wsPath, "rm", cmdargs)
|
||||
}
|
||||
|
||||
func CopyDir(src string, dest string) error {
|
||||
srcInfo, err := os.Stat(src)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if !srcInfo.IsDir() {
|
||||
return fmt.Errorf("%s is not a directory", src)
|
||||
}
|
||||
|
||||
err = os.MkdirAll(dest, srcInfo.Mode())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
items, err := ioutil.ReadDir(src)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, item := range items {
|
||||
srcPath := filepath.Join(src, item.Name())
|
||||
destPath := filepath.Join(dest, item.Name())
|
||||
|
||||
if item.IsDir() {
|
||||
err = CopyDir(srcPath, destPath)
|
||||
if err != nil {
|
||||
fmt.Printf("error copying directory %s to %s: %s\n", srcPath, destPath, err.Error())
|
||||
}
|
||||
} else {
|
||||
err = CopyFile(srcPath, destPath)
|
||||
if err != nil {
|
||||
fmt.Printf("error copying file %s to %s: %s\n", srcPath, destPath, err.Error())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func CopyFile(src string, dest string) error {
|
||||
srcFile, err := os.Open(src)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer srcFile.Close()
|
||||
|
||||
destFile, err := os.Create(dest)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer destFile.Close()
|
||||
|
||||
_, err = io.Copy(destFile, srcFile)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = destFile.Sync()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
srcInfo, err := os.Stat(src)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = os.Chmod(dest, srcInfo.Mode())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func CheckUpdates() {
|
||||
fmt.Println("Checking for Edgebox System Updates.")
|
||||
|
||||
// Configure the service and start it
|
||||
cmd := exec.Command("sh", "/home/system/components/updater/run.sh", "--check")
|
||||
stdout, err := cmd.StdoutPipe()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
scanner := bufio.NewScanner(stdout)
|
||||
err = cmd.Start()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
for scanner.Scan() {
|
||||
// fmt.Println(scanner.Text())
|
||||
text := scanner.Text()
|
||||
fmt.Println(text)
|
||||
}
|
||||
if scanner.Err() != nil {
|
||||
cmd.Process.Kill()
|
||||
cmd.Wait()
|
||||
fmt.Println("Error running updates check.")
|
||||
utils.WriteOption("SYSTEM_UPDATES", "[]")
|
||||
return
|
||||
}
|
||||
|
||||
// Read targets.env file into JSON list structure
|
||||
targets := []string{}
|
||||
targetsFile, err := os.Open("/home/system/components/updater/targets.env")
|
||||
if err != nil {
|
||||
fmt.Println("No targets.env file found. Skipping.")
|
||||
utils.WriteOption("SYSTEM_UPDATES", "[]")
|
||||
return
|
||||
}
|
||||
defer targetsFile.Close()
|
||||
scanner = bufio.NewScanner(targetsFile)
|
||||
for scanner.Scan() {
|
||||
text := scanner.Text()
|
||||
// text line should look like: {"target": "<target>", "version": "<version>"}
|
||||
target := strings.Split(text, "=")
|
||||
newText := "{\"target\": \"" + strings.Replace(target[0], "_VERSION", "", -1) + "\", \"version\": \"" + target[1] + "\"}"
|
||||
targets = append(targets, newText)
|
||||
}
|
||||
if scanner.Err() != nil {
|
||||
fmt.Println("Error reading update targets file.")
|
||||
utils.WriteOption("SYSTEM_UPDATES", "[]")
|
||||
return
|
||||
}
|
||||
|
||||
// convert targets to string
|
||||
targetsString := strings.Join(targets, ",")
|
||||
targetsString = "[" + targetsString + "]"
|
||||
|
||||
fmt.Println(targetsString)
|
||||
|
||||
// Write option with targets
|
||||
utils.WriteOption("SYSTEM_UPDATES", targetsString)
|
||||
}
|
||||
|
||||
func ApplyUpdates() {
|
||||
fmt.Println("Applying Edgebox System Updates.")
|
||||
|
||||
utils.WriteOption("UPDATING_SYSTEM", "true")
|
||||
|
||||
// Configure the service and start it
|
||||
cmd := exec.Command("sh", "/home/system/components/updater/run.sh", "--update")
|
||||
stdout, err := cmd.StdoutPipe()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
scanner := bufio.NewScanner(stdout)
|
||||
err = cmd.Start()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
for scanner.Scan() {
|
||||
fmt.Println(scanner.Text())
|
||||
text := scanner.Text()
|
||||
fmt.Println(text)
|
||||
}
|
||||
if scanner.Err() != nil {
|
||||
cmd.Process.Kill()
|
||||
cmd.Wait()
|
||||
panic(scanner.Err())
|
||||
}
|
||||
|
||||
// If the system did not yet restart, set updating system to false
|
||||
utils.WriteOption("UPDATING_SYSTEM", "false")
|
||||
}
|
||||
|
||||
func FetchBrowserDevPasswordFromFile() (string, error) {
|
||||
fmt.Println("Executing FetchBrowserDevPasswordFromFile")
|
||||
|
||||
// Read the "password" entry on the yaml file
|
||||
// Read the yaml file in system.GetPath(BrowserDevPasswordFileLocation)
|
||||
yamlFile, err := ioutil.ReadFile(utils.GetPath(utils.BrowserDevPasswordFileLocation))
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
// Parse the yaml file and get the "password" entry
|
||||
var yamlFileMap yaml.MapSlice
|
||||
err = yaml.Unmarshal(yamlFile, &yamlFileMap)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
for _, item := range yamlFileMap {
|
||||
key, value := item.Key, item.Value
|
||||
if key == "password" {
|
||||
if pwString, ok := value.(string); ok {
|
||||
return pwString, nil
|
||||
} else {
|
||||
return "", errors.New("password value is not a string")
|
||||
}
|
||||
}
|
||||
}
|
||||
return "", errors.New("password key not found")
|
||||
}
|
||||
|
||||
func SetBrowserDevPasswordFile(password string) error {
|
||||
// Get current password from file
|
||||
currentPassword, err := FetchBrowserDevPasswordFromFile()
|
||||
if err != nil {
|
||||
fmt.Println("Error fetching current password from file.")
|
||||
return err
|
||||
}
|
||||
|
||||
// Write the new password on the file using ReplaceTextInFile
|
||||
err = ReplaceTextInFile(utils.GetPath(utils.BrowserDevPasswordFileLocation), currentPassword, password)
|
||||
if err != nil {
|
||||
fmt.Println("Error writing new password to file.")
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func ReplaceTextInFile(filePath string, oldText string, newText string) error {
|
||||
// Open the file for reading
|
||||
file, err := os.OpenFile(filePath, os.O_RDWR, 0644)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Read the file contents
|
||||
data, err := ioutil.ReadAll(file)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Close the file
|
||||
err = file.Close()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Replace the text in the file
|
||||
newData := strings.Replace(string(data), oldText, newText, -1)
|
||||
|
||||
// Write the new data back to the file
|
||||
err = ioutil.WriteFile(filePath, []byte(newData), 0644)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -3,6 +3,7 @@ package utils
|
|||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"database/sql"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
|
|
@ -15,7 +16,7 @@ import (
|
|||
)
|
||||
|
||||
// ExecAndStream : Runs a terminal command, but streams progress instead of outputting. Ideal for long lived process that need to be logged.
|
||||
func ExecAndStream(path string, command string, args []string) {
|
||||
func ExecAndStream(path string, command string, args []string) string {
|
||||
|
||||
cmd := exec.Command(command, args...)
|
||||
|
||||
|
|
@ -26,13 +27,17 @@ func ExecAndStream(path string, command string, args []string) {
|
|||
|
||||
err := cmd.Run()
|
||||
|
||||
outStr, errStr := string(stdoutBuf.Bytes()), string(stderrBuf.Bytes())
|
||||
|
||||
returnVal := outStr
|
||||
if err != nil {
|
||||
fmt.Printf("cmd.Run() failed with %s\n", err)
|
||||
returnVal = errStr
|
||||
}
|
||||
|
||||
outStr, errStr := string(stdoutBuf.Bytes()), string(stderrBuf.Bytes())
|
||||
fmt.Printf("\nout:\n%s\nerr:\n%s\n", outStr, errStr)
|
||||
|
||||
return returnVal
|
||||
}
|
||||
|
||||
// Exec : Runs a terminal Command, catches and logs errors, returns the result.
|
||||
|
|
@ -80,7 +85,7 @@ func DeleteEmptySlices(s []string) []string {
|
|||
func GetSQLiteDbConnectionDetails() string {
|
||||
|
||||
var apiEnv map[string]string
|
||||
apiEnv, err := godotenv.Read(GetPath("apiEnvFileLocation"))
|
||||
apiEnv, err := godotenv.Read(GetPath(ApiEnvFileLocation))
|
||||
|
||||
if err != nil {
|
||||
log.Fatal("Error loading .env file")
|
||||
|
|
@ -99,6 +104,19 @@ func GetSQLiteFormattedDateTime(t time.Time) string {
|
|||
return formatedDatetime
|
||||
}
|
||||
|
||||
const BackupPasswordFileLocation string = "backupPasswordFileLocation"
|
||||
const CloudEnvFileLocation string = "cloudEnvFileLocation"
|
||||
const ApiEnvFileLocation string = "apiEnvFileLocation"
|
||||
const ApiPath string = "apiPath"
|
||||
const EdgeAppsPath string = "edgeAppsPath"
|
||||
const EdgeAppsBackupPath string = "edgeAppsBackupPath"
|
||||
const WsPath string = "wsPath"
|
||||
const BrowserDevPath string = "browserDevPath"
|
||||
const LoggerPath string = "loggerPath"
|
||||
const BrowserDevPasswordFileLocation string = "browserDevPasswordFileLocation"
|
||||
const BrowserDevProxyPath string = "browserDevProxyPath"
|
||||
|
||||
|
||||
// GetPath : Returns either the hardcoded path, or a overwritten value via .env file at project root. Register paths here for seamless working code between dev and prod environments ;)
|
||||
func GetPath(pathKey string) string {
|
||||
|
||||
|
|
@ -112,7 +130,15 @@ func GetPath(pathKey string) string {
|
|||
}
|
||||
|
||||
switch pathKey {
|
||||
case "apiEnvFileLocation":
|
||||
case CloudEnvFileLocation:
|
||||
|
||||
if env["CLOUD_ENV_FILE_LOCATION"] != "" {
|
||||
targetPath = env["CLOUD_ENV_FILE_LOCATION"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/api/cloud.env"
|
||||
}
|
||||
|
||||
case ApiEnvFileLocation:
|
||||
|
||||
if env["API_ENV_FILE_LOCATION"] != "" {
|
||||
targetPath = env["API_ENV_FILE_LOCATION"]
|
||||
|
|
@ -120,7 +146,15 @@ func GetPath(pathKey string) string {
|
|||
targetPath = "/home/system/components/api/edgebox.env"
|
||||
}
|
||||
|
||||
case "edgeAppsPath":
|
||||
case ApiPath:
|
||||
|
||||
if env["API_PATH"] != "" {
|
||||
targetPath = env["API_PATH"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/api/"
|
||||
}
|
||||
|
||||
case EdgeAppsPath:
|
||||
|
||||
if env["EDGEAPPS_PATH"] != "" {
|
||||
targetPath = env["EDGEAPPS_PATH"]
|
||||
|
|
@ -128,7 +162,14 @@ func GetPath(pathKey string) string {
|
|||
targetPath = "/home/system/components/apps/"
|
||||
}
|
||||
|
||||
case "wsPath":
|
||||
case EdgeAppsBackupPath:
|
||||
if env["EDGEAPPS_BACKUP_PATH"] != "" {
|
||||
targetPath = env["EDGEAPPS_BACKUP_PATH"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/backups/"
|
||||
}
|
||||
|
||||
case WsPath:
|
||||
|
||||
if env["WS_PATH"] != "" {
|
||||
targetPath = env["WS_PATH"]
|
||||
|
|
@ -136,6 +177,43 @@ func GetPath(pathKey string) string {
|
|||
targetPath = "/home/system/components/ws/"
|
||||
}
|
||||
|
||||
case BrowserDevPath:
|
||||
|
||||
if env["BROWSERDEV_PATH"] != "" {
|
||||
targetPath = env["BROWSERDEV_PATH"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/dev/"
|
||||
}
|
||||
|
||||
case LoggerPath:
|
||||
if env["LOGGER_PATH"] != "" {
|
||||
targetPath = env["LOGGER_PATH"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/logger/"
|
||||
}
|
||||
|
||||
case BackupPasswordFileLocation:
|
||||
|
||||
if env["BACKUP_PASSWORD_FILE_LOCATION"] != "" {
|
||||
targetPath = env["BACKUP_PASSWORD_FILE_LOCATION"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/backups/pw.txt"
|
||||
}
|
||||
|
||||
case BrowserDevPasswordFileLocation:
|
||||
if env["BROWSERDEV_PASSWORD_FILE_LOCATION"] != "" {
|
||||
targetPath = env["BROWSERDEV_PASSWORD_FILE_LOCATION"]
|
||||
} else {
|
||||
targetPath = "/root/.config/code-server/config.yaml"
|
||||
}
|
||||
|
||||
case BrowserDevProxyPath:
|
||||
if env["BROWSERDEV_PROXY_PATH"] != "" {
|
||||
targetPath = env["BROWSERDEV_PROXY_PATH"]
|
||||
} else {
|
||||
targetPath = "/home/system/components/dev/"
|
||||
}
|
||||
|
||||
default:
|
||||
|
||||
log.Printf("path_key %s nonexistant in GetPath().\n", pathKey)
|
||||
|
|
@ -145,3 +223,71 @@ func GetPath(pathKey string) string {
|
|||
return targetPath
|
||||
|
||||
}
|
||||
|
||||
// WriteOption : Writes a key value pair option into the api shared database
|
||||
func WriteOption(optionKey string, optionValue string) {
|
||||
|
||||
db, err := sql.Open("sqlite3", GetSQLiteDbConnectionDetails())
|
||||
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
statement, err := db.Prepare("REPLACE into option (name, value, created, updated) VALUES (?, ?, ?, ?);") // Prepare SQL Statement
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
formatedDatetime := GetSQLiteFormattedDateTime(time.Now())
|
||||
|
||||
_, err = statement.Exec(optionKey, optionValue, formatedDatetime, formatedDatetime) // Execute SQL Statement
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
db.Close()
|
||||
}
|
||||
|
||||
// ReadOption : Reads a key value pair option from the api shared database
|
||||
func ReadOption(optionKey string) string {
|
||||
|
||||
db, err := sql.Open("sqlite3", GetSQLiteDbConnectionDetails())
|
||||
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
var optionValue string
|
||||
|
||||
err = db.QueryRow("SELECT value FROM option WHERE name = ?", optionKey).Scan(&optionValue)
|
||||
|
||||
if err != nil {
|
||||
log.Println(err.Error())
|
||||
}
|
||||
|
||||
db.Close()
|
||||
|
||||
return optionValue
|
||||
}
|
||||
|
||||
// DeleteOption : Deletes a key value pair option from the api shared database
|
||||
func DeleteOption(optionKey string) {
|
||||
|
||||
db, err := sql.Open("sqlite3", GetSQLiteDbConnectionDetails())
|
||||
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
statement, err := db.Prepare("DELETE FROM option WHERE name = ?;") // Prepare SQL Statement
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
_, err = statement.Exec(optionKey) // Execute SQL Statement
|
||||
if err != nil {
|
||||
log.Fatal(err.Error())
|
||||
}
|
||||
|
||||
db.Close()
|
||||
}
|
||||
|
|
|
|||
|
|
@ -89,8 +89,7 @@ func TestGetPath(t *testing.T) {
|
|||
t.Fail()
|
||||
}
|
||||
|
||||
validPathKey := "wsPath"
|
||||
result = GetPath(validPathKey)
|
||||
result = GetPath(WsPath)
|
||||
if result != "/home/system/components/ws/" {
|
||||
t.Log("Expected /home/system/components/ws/ but got", result)
|
||||
t.Fail()
|
||||
|
|
|
|||
|
|
@ -0,0 +1,6 @@
|
|||
#!/usr/bin/env sh
|
||||
|
||||
echo "Starting script login"
|
||||
cloudflared tunnel login 2>&1 | tee /home/system/components/edgeboxctl/scripts/output.log &
|
||||
echo "sleeping 5 seconds"
|
||||
sleep 5
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
#!/usr/bin/env sh
|
||||
|
||||
echo "Starting script create"
|
||||
# script -q -c "cloudflared tunnel login 2>&1 | tee /app/output.log" &
|
||||
cloudflared tunnel create edgebox 2>&1 | tee /home/system/components/edgeboxctl/scripts/output.log
|
||||
echo "sleeping 5 seconds"
|
||||
sleep 5
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
#!/usr/bin/env sh
|
||||
|
||||
echo "Starting script delete"
|
||||
TUNNEL_ORIGIN_CERT=/home/system/.cloudflared/cert.pem
|
||||
cloudflared tunnel delete edgebox 2>&1 | tee /home/system/components/edgeboxctl/scripts/output.log &
|
||||
echo "sleeping 5 seconds"
|
||||
sleep 5
|
||||
Loading…
Reference in New Issue