Compare commits
45 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9ca75af03c | ||
|
|
56f710e056 | ||
|
|
ce2f365c56 | ||
|
|
69b2ae6514 | ||
|
|
50bdfa73bc | ||
|
|
37a9e55061 | ||
|
|
42d6985dab | ||
|
|
ec8f853c84 | ||
|
|
8ea167ec2d | ||
|
|
3dfa89d35a | ||
|
|
2b3f67ae33 | ||
|
|
0d5b289a2c | ||
|
|
ebc969a351 | ||
|
|
27d40f5498 | ||
|
|
7fb9e78b5e | ||
|
|
cbbf20848a | ||
|
|
76810b3fff | ||
|
|
d8e346ddb4 | ||
|
|
055c7e7a23 | ||
|
|
9d9b968e60 | ||
|
|
dae493c9fd | ||
|
|
41d95a2143 | ||
|
|
6facc0210d | ||
|
|
650f7d727d | ||
|
|
9126cdd604 | ||
|
|
aed95909cd | ||
|
|
27bdc129bc | ||
|
|
81f1c06662 | ||
|
|
3b47426362 | ||
|
|
3b0f29379c | ||
|
|
979475e2a8 | ||
|
|
1368e9abbb | ||
|
|
e0488a7d88 | ||
|
|
ee8fc37867 | ||
|
|
9ce400a784 | ||
|
|
88fde66d20 | ||
|
|
a7469cfee9 | ||
|
|
8d748ef8a0 | ||
|
|
401392d1b1 | ||
|
|
6759dbd23f | ||
|
|
71ebec77c2 | ||
|
|
7426bfcc67 | ||
|
|
f0560bf8b8 | ||
|
|
718884daed | ||
|
|
8ca91465f6 |
2
.github/workflows/publish-image.yml
vendored
2
.github/workflows/publish-image.yml
vendored
@@ -2,8 +2,6 @@ name: Publish Image
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- 'main'
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
|
||||
62
.github/workflows/publish-web.yml
vendored
Normal file
62
.github/workflows/publish-web.yml
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
name: Build and Deploy Web
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
paths:
|
||||
- web/**
|
||||
- ./bootstrap.sh
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: ./web
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
cache: 'npm'
|
||||
cache-dependency-path: 'web/package-lock.json'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm install
|
||||
|
||||
- name: build
|
||||
env:
|
||||
BASE_PATH: ''
|
||||
run: |
|
||||
npm run build
|
||||
touch build/.nojekyll
|
||||
cp ../bootstrap.sh build/bootstrap.sh
|
||||
echo "shokku.dev" > build/CNAME
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v1
|
||||
with:
|
||||
path: ./web/build
|
||||
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
steps:
|
||||
- uses: actions/deploy-pages@v1
|
||||
id: deployment
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -3,7 +3,7 @@
|
||||
ui/node_modules/
|
||||
ui/.svelte-kit
|
||||
ui/dist
|
||||
|
||||
cmd/shokku/dist
|
||||
.env
|
||||
.test_keyfile
|
||||
test.db
|
||||
|
||||
6
Justfile
6
Justfile
@@ -5,7 +5,8 @@ web_npm := 'npm --prefix web'
|
||||
shokku_image := 'texm/shokku:latest'
|
||||
dokku_image := 'dokku/dokku:0.30.2'
|
||||
dokku_container_name := 'shokku-dokku-dev'
|
||||
dokku_data_mount_dir := '/tmp/var/lib/dokku'
|
||||
# for linux can this just be /var/lib/dokku ?
|
||||
dokku_data_mount_dir := '/tmp/colima/var/lib/dokku'
|
||||
dokku_ssh_host := '127.0.0.1'
|
||||
dokku_ssh_port := '3022'
|
||||
db_path := 'test.db'
|
||||
@@ -143,8 +144,7 @@ _setup-dokku:
|
||||
for plugin in redis postgres mongo mysql letsencrypt; do \
|
||||
echo "installing $plugin"; \
|
||||
docker exec {{dokku_container_name}} bash -c \
|
||||
"dokku plugin:install https://github.com/dokku/dokku-$plugin.git" \
|
||||
> /dev/null; \
|
||||
"dokku plugin:install https://github.com/dokku/dokku-$plugin.git" > /dev/null; \
|
||||
done
|
||||
|
||||
# to fix plugins: https://github.com/dokku/dokku/issues/5004
|
||||
|
||||
674
LICENSE
674
LICENSE
@@ -1,21 +1,661 @@
|
||||
MIT License
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (c) 2023 github.com/texm
|
||||
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.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Preamble
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"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.
|
||||
|
||||
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.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
17
README.md
17
README.md
@@ -1,3 +1,18 @@
|
||||
# shokku
|
||||

|
||||
|
||||
a web frontend for dokku
|
||||
_(show-dokku)_
|
||||
|
||||
A friendly interface for [Dokku](https://github.com/dokku/dokku), the open-source Platform-as-a-Service.
|
||||
|
||||

|
||||
|
||||
## Usage
|
||||
Read the [docs](https://shokku.dev/docs)
|
||||
|
||||
## Support
|
||||
Shokku is provided 'as-is' - no support is available.
|
||||
Consider [Dokku Pro](https://pro.dokku.com).
|
||||
|
||||
## License
|
||||
[AGPL License](https://github.com/texm/shokku/blob/master/LICENSE)
|
||||
|
||||
58
bootstrap.sh
58
bootstrap.sh
@@ -10,7 +10,7 @@ DOKKU_STORAGE_DIR="/var/lib/dokku/data/storage/"
|
||||
SHOKKU_DATA_DIR="$DOKKU_STORAGE_DIR/shokku"
|
||||
SHOKKU_APP_DATA_MOUNT_PATH="$SHOKKU_DATA_DIR:/data"
|
||||
SHOKKU_VERSION=${SHOKKU_VERSION:-"latest"}
|
||||
SHOKKU_IMAGE="registry.gitlab.com/texm/shokku:$SHOKKU_VERSION"
|
||||
SHOKKU_IMAGE="ghcr.io/texm/shokku:$SHOKKU_VERSION"
|
||||
|
||||
SHOKKU_DOKKU_USER="shokkuadmin"
|
||||
DISTROLESS_NONROOT_UID="65532"
|
||||
@@ -18,71 +18,74 @@ DISTROLESS_NONROOT_UID="65532"
|
||||
clean-shokku() {
|
||||
echo "=> checking for existing resources"
|
||||
|
||||
if dokku apps:exists shokku &> /dev/null; then
|
||||
if dokku apps:exists shokku &>/dev/null; then
|
||||
echo "==> destroying old dokku app"
|
||||
dokku apps:destroy --force shokku &> /dev/null
|
||||
dokku apps:destroy --force shokku &>/dev/null
|
||||
fi
|
||||
|
||||
if dokku ssh-keys:list "$SHOKKU_DOKKU_USER" &> /dev/null; then
|
||||
if dokku ssh-keys:list "$SHOKKU_DOKKU_USER" &>/dev/null; then
|
||||
echo "==> removing existing dokku ssh key"
|
||||
dokku ssh-keys:remove $SHOKKU_DOKKU_USER;
|
||||
dokku ssh-keys:remove $SHOKKU_DOKKU_USER
|
||||
fi
|
||||
|
||||
echo "==> done"
|
||||
}
|
||||
|
||||
create-shokku-app() {
|
||||
clean-shokku
|
||||
echo "=> pulling version '$SHOKKU_VERSION'"
|
||||
|
||||
echo "=> pulling image (version: $SHOKKU_VERSION)"
|
||||
HOST_SSH_PORT=$(grep "Port " /etc/ssh/sshd_config | awk '{ print $2 }')
|
||||
docker pull "$SHOKKU_IMAGE" &> /dev/null
|
||||
docker pull "$SHOKKU_IMAGE" &>/dev/null
|
||||
SHOKKU_IMAGE_DIGEST=$(docker inspect --format='{{index .RepoDigests 0}}' "$SHOKKU_IMAGE")
|
||||
|
||||
echo "=> creating & configuring app"
|
||||
dokku apps:create shokku &> /dev/null
|
||||
echo "=> creating & configuring dokku app"
|
||||
dokku apps:create shokku &>/dev/null
|
||||
dokku docker-options:add shokku deploy \
|
||||
"--add-host=host.docker.internal:host-gateway" &> /dev/null
|
||||
"--add-host=host.docker.internal:host-gateway" &>/dev/null
|
||||
dokku config:set shokku \
|
||||
DOKKU_SSH_HOST='host.docker.internal' \
|
||||
DOKKU_SSH_PORT="$HOST_SSH_PORT" &> /dev/null
|
||||
DOKKU_SSH_PORT="$HOST_SSH_PORT" &>/dev/null
|
||||
|
||||
echo "==> creating storage"
|
||||
dokku storage:ensure-directory shokku --chown false &> /dev/null
|
||||
dokku storage:mount shokku "$SHOKKU_APP_DATA_MOUNT_PATH" &> /dev/null
|
||||
chown -R "$DISTROLESS_NONROOT_UID":"$DISTROLESS_NONROOT_UID" "$SHOKKU_DATA_DIR" &> /dev/null
|
||||
dokku storage:ensure-directory shokku --chown false &>/dev/null
|
||||
dokku storage:mount shokku "$SHOKKU_APP_DATA_MOUNT_PATH" &>/dev/null
|
||||
chown -R "$DISTROLESS_NONROOT_UID":"$DISTROLESS_NONROOT_UID" "$SHOKKU_DATA_DIR" &>/dev/null
|
||||
|
||||
echo "==> bootstrapping"
|
||||
dokku config:set shokku DOKKU_SKIP_DEPLOY=true &> /dev/null
|
||||
dokku git:from-image shokku "$SHOKKU_IMAGE_DIGEST" &> /dev/null
|
||||
dokku config:set shokku DOKKU_SKIP_DEPLOY=true &>/dev/null
|
||||
dokku git:from-image shokku "$SHOKKU_IMAGE_DIGEST" &>/dev/null
|
||||
|
||||
shokku_ssh_key=$(dokku run shokku bootstrap) &> /dev/null
|
||||
echo "$shokku_ssh_key" | dokku ssh-keys:add "$SHOKKU_DOKKU_USER" &> /dev/null
|
||||
shokku_ssh_key=$(dokku run shokku bootstrap) &>/dev/null
|
||||
echo "$shokku_ssh_key" | dokku ssh-keys:add "$SHOKKU_DOKKU_USER" &>/dev/null
|
||||
|
||||
echo "==> deploying"
|
||||
dokku config:unset shokku DOKKU_SKIP_DEPLOY &> /dev/null
|
||||
dokku config:unset shokku DOKKU_SKIP_DEPLOY &>/dev/null
|
||||
|
||||
echo "==> enabling letsencrypt"
|
||||
dokku letsencrypt:enable shokku &> /dev/null
|
||||
dokku letsencrypt:enable shokku &>/dev/null
|
||||
}
|
||||
|
||||
main() {
|
||||
if [[ "$(id -u)" != "0" ]]; then
|
||||
echo "This script must be run as root" 1>&2
|
||||
exit 1
|
||||
echo "This script must be run as root" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! command -v dokku &> /dev/null; then
|
||||
echo "Please install dokku first using the instructions at https://dokku.com" 1>&2
|
||||
exit
|
||||
if ! command -v dokku &>/dev/null; then
|
||||
echo "Please install dokku first using the instructions at https://dokku.com" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! dokku plugin:installed letsencrypt; then
|
||||
echo "Please setup letsencrypt using the instructions at https://dokku.com/docs/deployment/application-deployment/#setting-up-ssl" 1>&2
|
||||
exit
|
||||
exit 1
|
||||
fi
|
||||
|
||||
for plugin in redis postgres mongo mysql; do
|
||||
if ! dokku plugin:installed $plugin; then
|
||||
echo "=> Installing plugin $plugin"
|
||||
dokku plugin:install https://github.com/dokku/dokku-$plugin.git $plugin &> /dev/null
|
||||
dokku plugin:install https://github.com/dokku/dokku-$plugin.git $plugin &>/dev/null
|
||||
fi
|
||||
done
|
||||
|
||||
@@ -91,6 +94,7 @@ main() {
|
||||
shokku_app_domain=$(dokku domains:report shokku --domains-app-vhosts)
|
||||
shokku_setup_key=$(dokku logs -q shokku | grep setup_key | jq ".setup_key")
|
||||
|
||||
echo "---"
|
||||
echo "=> shokku installed and running "
|
||||
echo "--- proceed with setup using key $shokku_setup_key at https://$shokku_app_domain ---"
|
||||
}
|
||||
|
||||
0
cmd/shokku/dist/bleh
vendored
0
cmd/shokku/dist/bleh
vendored
@@ -267,9 +267,7 @@ type GetAppConfigResponse struct {
|
||||
|
||||
type SetAppConfigRequest struct {
|
||||
Name string `json:"name" validate:"appName"`
|
||||
// validate keys and values are alphanumeric
|
||||
Config map[string]string `json:"config" validate:"dive,keys,alphanum,endkeys,alphanum"`
|
||||
// Config map[string]string `json:"config"`
|
||||
Config map[string]string `json:"config"`
|
||||
}
|
||||
|
||||
type GetAppStorageRequest struct {
|
||||
|
||||
@@ -42,8 +42,8 @@ func NewRequestValidator() *requestValidator {
|
||||
if err != nil {
|
||||
log.Fatal().Err(err).Msg("failed to register validator")
|
||||
}
|
||||
v.RegisterAlias("appName", "appNameChars,min=4,max=16")
|
||||
v.RegisterAlias("processName", "appNameChars,min=2,max=16")
|
||||
v.RegisterAlias("appName", "appNameChars,min=4,max=32")
|
||||
v.RegisterAlias("processName", "appNameChars,min=2,max=32")
|
||||
|
||||
return &requestValidator{validator: v}
|
||||
}
|
||||
|
||||
@@ -4,14 +4,15 @@ import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"time"
|
||||
|
||||
gh "github.com/google/go-github/v48/github"
|
||||
"github.com/rs/zerolog/log"
|
||||
"gitlab.com/texm/shokku/internal/env"
|
||||
"gitlab.com/texm/shokku/internal/models"
|
||||
"gorm.io/gorm/clause"
|
||||
"io"
|
||||
"net/http"
|
||||
"time"
|
||||
)
|
||||
|
||||
type githubUser struct {
|
||||
@@ -49,10 +50,26 @@ func SyncUsersToDB(e *env.Env) error {
|
||||
for _, install := range installs {
|
||||
var members []*gh.User
|
||||
var err error
|
||||
var response *gh.Response
|
||||
var options *gh.ListMembersOptions
|
||||
if install.GetAccount().GetType() == "Organization" {
|
||||
var temp_members []*gh.User
|
||||
|
||||
insClient := client.GetInstallationClient(install.GetID())
|
||||
org := install.GetAccount().GetLogin()
|
||||
members, _, err = insClient.Organizations.ListMembers(ctx, org, nil)
|
||||
temp_members, response, err = insClient.Organizations.ListMembers(ctx, org, options)
|
||||
members = append(members, temp_members...)
|
||||
|
||||
for response.NextPage != 0 {
|
||||
options := &gh.ListMembersOptions{
|
||||
ListOptions: gh.ListOptions{
|
||||
Page: response.NextPage,
|
||||
},
|
||||
}
|
||||
temp_members, response, err = insClient.Organizations.ListMembers(ctx, org, options)
|
||||
members = append(members, temp_members...)
|
||||
}
|
||||
|
||||
} else {
|
||||
members = append(members, install.GetAccount())
|
||||
}
|
||||
|
||||
879
ui/package-lock.json
generated
879
ui/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -10,19 +10,19 @@
|
||||
"devDependencies": {
|
||||
"@sveltejs/adapter-auto": "next",
|
||||
"@sveltejs/adapter-static": "^1.0.0-next.29",
|
||||
"@sveltejs/kit": "next",
|
||||
"@sveltejs/kit": "^1.15.9",
|
||||
"autoprefixer": "^10.4.13",
|
||||
"cssnano": "^5.1.8",
|
||||
"postcss": "^8.4.21",
|
||||
"prettier": "^2.8.1",
|
||||
"prettier-plugin-svelte": "^2.9.0",
|
||||
"svelte": "^3.44.0",
|
||||
"tabler-icons-svelte": "^1.8.0",
|
||||
"tailwindcss": "^3.2.4"
|
||||
},
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"@sveltestack/svelte-query": "^1.6.0",
|
||||
"@tabler/icons-svelte": "^2.17.0",
|
||||
"daisyui": "^2.14.3",
|
||||
"js-cookie": "^3.0.1",
|
||||
"jwt-decode": "^3.1.2",
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
}
|
||||
</script>
|
||||
|
||||
<div class="max-w-80 max-h-96 overflow-x-scroll" bind:this={msgContainer}>
|
||||
<div class="max-w-80 max-h-96 overflow-x-auto" bind:this={msgContainer}>
|
||||
{#each output as line, i}
|
||||
<pre data-prefix={i} class:text-warning={line["type"] === "stderr"}><code
|
||||
>{line["message"]}</code
|
||||
|
||||
@@ -47,7 +47,7 @@
|
||||
</div>
|
||||
|
||||
<div
|
||||
class="flex-grow max-w-80 h-80 overflow-x-scroll bg-base-content p-2"
|
||||
class="flex-grow max-w-80 h-80 overflow-x-auto bg-base-content p-2"
|
||||
bind:this={scrollDiv}
|
||||
>
|
||||
<div class="whitespace-pre-wrap flex flex-col">
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<div class="flex flex-row max-h-full justify-center">
|
||||
<div class="card flex-shrink-0 w-full max-w-xl max-h-full">
|
||||
<div class="card-body overflow-scroll">
|
||||
<div class="card-body overflow-auto">
|
||||
<slot />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
<div class="hidden sm:flex rounded-lg flex-row w-full max-h-full">
|
||||
<slot name="sidebar" />
|
||||
|
||||
<div class="pl-3 h-full w-full flex flex-col overflow-x-scroll">
|
||||
<div class="pl-3 h-full w-full flex flex-col overflow-x-auto">
|
||||
<div class="w-full">
|
||||
<slot name="header" />
|
||||
</div>
|
||||
|
||||
<div class="overflow-scroll w-full h-full rounded-lg">
|
||||
<div class="overflow-auto w-full h-full rounded-lg">
|
||||
<slot name="content" />
|
||||
</div>
|
||||
</div>
|
||||
@@ -18,8 +18,8 @@
|
||||
<slot name="header" />
|
||||
<slot name="sidebar" />
|
||||
|
||||
<div class="overflow-scroll h-full">
|
||||
<div class="rounded-lg w-full h-full overflow-scroll pb-6">
|
||||
<div class="overflow-auto h-full">
|
||||
<div class="rounded-lg w-full h-full overflow-auto pb-6">
|
||||
<slot name="content" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,34 +1,36 @@
|
||||
<script>
|
||||
import CirclePlus from "tabler-icons-svelte/icons/CirclePlus.svelte";
|
||||
import CircleMinus from "tabler-icons-svelte/icons/CircleMinus.svelte";
|
||||
import Copy from "tabler-icons-svelte/icons/Copy.svelte";
|
||||
import Trash from "tabler-icons-svelte/icons/Trash.svelte";
|
||||
import Cloud from "tabler-icons-svelte/icons/Cloud.svelte";
|
||||
import RotateClockwise2 from "tabler-icons-svelte/icons/RotateClockwise2.svelte";
|
||||
import Stack from "tabler-icons-svelte/icons/Stack.svelte";
|
||||
import Folder from "tabler-icons-svelte/icons/Folder.svelte";
|
||||
import Link from "tabler-icons-svelte/icons/Link.svelte";
|
||||
import Unlink from "tabler-icons-svelte/icons/Unlink.svelte";
|
||||
import DeviceFloppy from "tabler-icons-svelte/icons/DeviceFloppy.svelte";
|
||||
import Pencil from "tabler-icons-svelte/icons/Pencil.svelte";
|
||||
import Tool from "tabler-icons-svelte/icons/Tool.svelte";
|
||||
import Box from "tabler-icons-svelte/icons/Box.svelte";
|
||||
import ChartCircles from "tabler-icons-svelte/icons/ChartCircles.svelte";
|
||||
import LayersSubtract from "tabler-icons-svelte/icons/LayersSubtract.svelte";
|
||||
import InfoCircle from "tabler-icons-svelte/icons/InfoCircle.svelte";
|
||||
import FileText from "tabler-icons-svelte/icons/FileText.svelte";
|
||||
import AlertCircle from "tabler-icons-svelte/icons/AlertCircle.svelte";
|
||||
import BrandGit from "tabler-icons-svelte/icons/BrandGit.svelte";
|
||||
import Database from "tabler-icons-svelte/icons/Database.svelte";
|
||||
import Settings from "tabler-icons-svelte/icons/Settings.svelte";
|
||||
import PlayerPlay from "tabler-icons-svelte/icons/PlayerPlay.svelte";
|
||||
import PlayerStop from "tabler-icons-svelte/icons/PlayerStop.svelte";
|
||||
import Upload from "tabler-icons-svelte/icons/Upload.svelte";
|
||||
import Terminal2 from "tabler-icons-svelte/icons/Terminal2.svelte";
|
||||
import ArrowLeft from "tabler-icons-svelte/icons/ArrowLeft.svelte";
|
||||
import ArrowRight from "tabler-icons-svelte/icons/ArrowRight.svelte";
|
||||
import Key from "tabler-icons-svelte/icons/Key.svelte";
|
||||
import ExternalLink from "tabler-icons-svelte/icons/ExternalLink.svelte";
|
||||
import {
|
||||
IconCirclePlus,
|
||||
IconCircleMinus,
|
||||
IconCopy,
|
||||
IconTrash,
|
||||
IconCloud,
|
||||
IconRotateClockwise2,
|
||||
IconStack,
|
||||
IconFolder,
|
||||
IconLink,
|
||||
IconUnlink,
|
||||
IconDeviceFloppy,
|
||||
IconPencil,
|
||||
IconTool,
|
||||
IconBox,
|
||||
IconChartCircles,
|
||||
IconLayersSubtract,
|
||||
IconInfoCircle,
|
||||
IconFileText,
|
||||
IconAlertCircle,
|
||||
IconBrandGit,
|
||||
IconDatabase,
|
||||
IconSettings,
|
||||
IconPlayerPlay,
|
||||
IconPlayerStop,
|
||||
IconUpload,
|
||||
IconTerminal2,
|
||||
IconArrowLeft,
|
||||
IconArrowRight,
|
||||
IconKey,
|
||||
IconExternalLink
|
||||
} from "@tabler/icons-svelte";
|
||||
|
||||
// using https://devicon.dev
|
||||
import Postgres from "./devicons/Postgres.svelte";
|
||||
@@ -47,44 +49,44 @@
|
||||
export let size = "md";
|
||||
|
||||
const icons = {
|
||||
add: CirclePlus,
|
||||
remove: CircleMinus,
|
||||
delete: Trash,
|
||||
"external-link": ExternalLink,
|
||||
add: IconCirclePlus,
|
||||
remove: IconCircleMinus,
|
||||
delete: IconTrash,
|
||||
"external-link": IconExternalLink,
|
||||
docker: Docker,
|
||||
go: Go,
|
||||
javascript: Javascript,
|
||||
python: Python,
|
||||
ruby: Ruby,
|
||||
cloud: Cloud,
|
||||
copy: Copy,
|
||||
restart: RotateClockwise2,
|
||||
build: Stack,
|
||||
rebuild: Stack,
|
||||
folder: Folder,
|
||||
link: Link,
|
||||
unlink: Unlink,
|
||||
save: DeviceFloppy,
|
||||
plus: CirclePlus,
|
||||
edit: Pencil,
|
||||
cube: Box,
|
||||
left: ArrowLeft,
|
||||
right: ArrowRight,
|
||||
key: Key,
|
||||
circles: ChartCircles,
|
||||
layers: LayersSubtract,
|
||||
info: InfoCircle,
|
||||
"file-text": FileText,
|
||||
warning: AlertCircle,
|
||||
error: AlertCircle,
|
||||
git: BrandGit,
|
||||
terminal: Terminal2,
|
||||
database: Database,
|
||||
spanner: Tool,
|
||||
settings: Settings,
|
||||
start: PlayerPlay,
|
||||
stop: PlayerStop,
|
||||
upload: Upload,
|
||||
cloud: IconCloud,
|
||||
copy: IconCopy,
|
||||
restart: IconRotateClockwise2,
|
||||
build: IconStack,
|
||||
rebuild: IconStack,
|
||||
folder: IconFolder,
|
||||
link: IconLink,
|
||||
unlink: IconUnlink,
|
||||
save: IconDeviceFloppy,
|
||||
plus: IconCirclePlus,
|
||||
edit: IconPencil,
|
||||
cube: IconBox,
|
||||
left: IconArrowLeft,
|
||||
right: IconArrowRight,
|
||||
key: IconKey,
|
||||
circles: IconChartCircles,
|
||||
layers: IconLayersSubtract,
|
||||
info: IconInfoCircle,
|
||||
"file-text": IconFileText,
|
||||
warning: IconAlertCircle,
|
||||
error: IconAlertCircle,
|
||||
git: IconBrandGit,
|
||||
terminal: IconTerminal2,
|
||||
database: IconDatabase,
|
||||
spanner: IconTool,
|
||||
settings: IconSettings,
|
||||
start: IconPlayerPlay,
|
||||
stop: IconPlayerStop,
|
||||
upload: IconUpload,
|
||||
postgres: Postgres,
|
||||
redis: Redis,
|
||||
sqlite: SQLite,
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
export let logs;
|
||||
</script>
|
||||
|
||||
<div class="overflow-x-scroll h-full bg-neutral px-4 rounded-lg">
|
||||
<div class="overflow-x-auto h-full bg-neutral px-4 rounded-lg">
|
||||
<div class="py-4 h-full text-neutral-content">
|
||||
{#each logs as line, i}
|
||||
<pre data-prefix={i}><code>{line.trim()}</code></pre>
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
</script>
|
||||
|
||||
<div
|
||||
class="menu rounded-box hidden sm:inline-block min-w-fit max-h-full bg-base-200 overflow-y-scroll shadow-lg h-fit"
|
||||
class="menu rounded-box hidden sm:inline-block min-w-fit max-h-full bg-base-200 overflow-y-auto shadow-lg h-fit"
|
||||
>
|
||||
{#each pages as info, i}
|
||||
<li class="">
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
<div
|
||||
class="flex flex-col bg-base-200 p-4 rounded-lg shadow-xl flex-grow max-h-full"
|
||||
>
|
||||
<div class="overflow-scroll" in:fly={{ y: 100, duration: 250 }}>
|
||||
<div class="overflow-auto" in:fly={{ y: 100, duration: 250 }}>
|
||||
<svelte:component
|
||||
this={steps[currentStep].component}
|
||||
{props}
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
const serviceStates = {};
|
||||
</script>
|
||||
|
||||
<div class="flex flex-col md:flex-row gap-8 p-4 h-full overflow-y-scroll">
|
||||
<div class="flex flex-col md:flex-row gap-8 p-4 h-full overflow-y-auto">
|
||||
<div class="hidden md:inline flex-grow" />
|
||||
<div class="max-w-full md:max-w-lg md:flex-grow">
|
||||
<DashboardCardList
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
</script>
|
||||
|
||||
<div
|
||||
class="flex gap-2 max-w-full overflow-scroll text-center items-center bg-base-100 p-4 rounded-lg"
|
||||
class="flex gap-2 max-w-full overflow-auto text-center items-center bg-base-100 p-4 rounded-lg"
|
||||
>
|
||||
<span class="text-lg">{name}</span>
|
||||
<div class="tooltip tooltip-left flex-grow" data-tip={tooltipText}>
|
||||
|
||||
@@ -6,9 +6,13 @@
|
||||
|
||||
<div class="navbar bg-neutral text-neutral-content flex items-center justify-between p-4 mx-auto">
|
||||
<slot name="sidebar-toggle" />
|
||||
<div class="flex-1">
|
||||
<a href={base + "/"} class="btn btn-ghost normal-case text-xl">shokku</a>
|
||||
</div>
|
||||
<a href={base + "/"}>
|
||||
<div class="flex-1 flex-row gap-4 btn btn-ghost p-0 sm:px-4">
|
||||
<img class="hidden sm:inline w-10 h-10"
|
||||
src="{base}/images/whale-boat-sm.png" alt="whale in boat logo" />
|
||||
<span class="normal-case text-lg sm:text-xl">Shokku</span>
|
||||
</div>
|
||||
</a>
|
||||
<div class="flex-none">
|
||||
<ul class="menu menu-horizontal px-3 gap-2">
|
||||
<li>
|
||||
|
||||
12
web/src/components/SocialShareMeta.svelte
Normal file
12
web/src/components/SocialShareMeta.svelte
Normal file
@@ -0,0 +1,12 @@
|
||||
<script>
|
||||
export let title = "";
|
||||
const cardImgUrl = "https://shokku.dev/images/share-card.png"
|
||||
</script>
|
||||
|
||||
<meta property="og:title" content={title}>
|
||||
<meta property="og:type" content="website" />
|
||||
<meta property="og:image" content={cardImgUrl}>
|
||||
<meta name="twitter:card" content={cardImgUrl}>
|
||||
|
||||
<meta property="og:description" content="Free and open source interface for the Dokku PaaS">
|
||||
<meta name="twitter:image:alt" content="Shokku Logo">
|
||||
@@ -1,9 +1,5 @@
|
||||
<script>
|
||||
import "$src/app.css";
|
||||
import "../app.css";
|
||||
</script>
|
||||
|
||||
<svelte:head>
|
||||
<title>Shokku</title>
|
||||
</svelte:head>
|
||||
|
||||
<slot />
|
||||
@@ -1,10 +1,18 @@
|
||||
<script>
|
||||
import SocialShareMeta from "$components/SocialShareMeta.svelte";
|
||||
import Navbar from "$components/Navbar.svelte";
|
||||
import Hero from "./Hero.svelte";
|
||||
import Features from "./Features.svelte";
|
||||
import Hero from "./Hero.svelte";
|
||||
import Features from "./Features.svelte";
|
||||
import Screenshots from "./Screenshots.svelte";
|
||||
import Footer from "./Footer.svelte";
|
||||
</script>
|
||||
|
||||
<div class="flex flex-col h-screen">
|
||||
<svelte:head>
|
||||
<title>Shokku</title>
|
||||
<SocialShareMeta title="Shokku" />
|
||||
</svelte:head>
|
||||
|
||||
<div class="flex flex-col bg-base-300">
|
||||
<div class="flex-shrink">
|
||||
<Navbar />
|
||||
</div>
|
||||
@@ -13,7 +21,15 @@
|
||||
<Hero />
|
||||
</div>
|
||||
|
||||
<div class="bg-base-300 justify-center p-8">
|
||||
<div class="flex flex-col md:flex-row justify-center p-8 gap-8">
|
||||
<div class="w-full md:w-3/5">
|
||||
<Screenshots />
|
||||
</div>
|
||||
|
||||
<Features />
|
||||
</div>
|
||||
|
||||
<div class="bg-base-200">
|
||||
<Footer />
|
||||
</div>
|
||||
</div>
|
||||
@@ -1,15 +1,14 @@
|
||||
<script>
|
||||
const features = [
|
||||
{title: "Free and Open Source", ref: "", description: "description"},
|
||||
{title: "Github Integration", ref: "", description: "description"},
|
||||
{title: "Services Support", ref: "", description: "description"},
|
||||
{title: "Services Support", ref: "", description: "description"},
|
||||
{title: "100% Free and Open Source", description: "free as in beer"},
|
||||
{title: "Github Integration", description: "secure authentication for single users or organisations"},
|
||||
{title: "Easy Setup", description: "ready to go in minutes"},
|
||||
]
|
||||
</script>
|
||||
|
||||
<div class="grid grid-flow-row sm:grid-flow-col sm:auto-cols-fr gap-4">
|
||||
<div class="flex flex-col gap-4">
|
||||
{#each features as feature}
|
||||
<div class="card bg-base-200 hover:bg-base-100 shadow-xl">
|
||||
<div class="card bg-base-100 shadow-xl max-w-md">
|
||||
<div class="card-body">
|
||||
<h2 class="card-title">{feature.title}</h2>
|
||||
<p>{feature.description}</p>
|
||||
|
||||
7
web/src/routes/Footer.svelte
Normal file
7
web/src/routes/Footer.svelte
Normal file
@@ -0,0 +1,7 @@
|
||||
<script>
|
||||
import {base} from "$app/paths";
|
||||
</script>
|
||||
|
||||
<div class="my-6 flex justify-center">
|
||||
<img class="w-24 h-24" src="{base}/images/whale-boat-sm.png" alt="whale in boat logo" />
|
||||
</div>
|
||||
@@ -8,9 +8,9 @@
|
||||
<div class="hero h-full">
|
||||
<div class="hero-content text-center flex-col py-10 px-0">
|
||||
<div class="max-w-md mb-4">
|
||||
<h1 class="text-5xl font-bold mb-2">A web interface for Dokku</h1>
|
||||
<p class="text-xl">
|
||||
an open-source self-hostable web UI to help
|
||||
<h1 class="text-5xl font-bold mb-4">A friendly interface for Dokku</h1>
|
||||
<p class="text-xl px-4">
|
||||
an open-source web UI to help
|
||||
<strong>configure</strong> and <strong>deploy</strong>
|
||||
your apps and services with <a class="link" href="https://dokku.com/">Dokku</a>
|
||||
</p>
|
||||
@@ -20,13 +20,13 @@
|
||||
</div>
|
||||
|
||||
<div class="flex flex-row gap-4 justify-center">
|
||||
<a href="{base}/docs">
|
||||
<a href="{base}/docs/intro">
|
||||
<button class="btn btn-primary text-primary-content">Get Started</button>
|
||||
</a>
|
||||
|
||||
<a href={demoUrl}>
|
||||
<!--a href={demoUrl}>
|
||||
<button class="btn btn-secondary text-secondary-content">Try the Demo</button>
|
||||
</a>
|
||||
</a-->
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,15 +1,27 @@
|
||||
<script>
|
||||
import {base} from "$app/paths";
|
||||
|
||||
const carouselImages = [
|
||||
{alt: "dashboard screenshot", src: "/images/dashboard-light.webp"},
|
||||
{alt: "app overview", src: "/images/app-overview.webp"},
|
||||
{alt: "service overview", src: "/images/service-overview.webp"},
|
||||
{alt: "dashboard screenshot", src: `${base}/images/dashboard-light.webp`},
|
||||
{alt: "dashboard screenshot", src: `${base}/images/dashboard-dark.webp`},
|
||||
{alt: "app overview", src: `${base}/images/app-overview.webp`},
|
||||
{alt: "service overview", src: `${base}/images/service-overview.webp`},
|
||||
]
|
||||
|
||||
const nextIdx = i => ((i + 1) % carouselImages.length);
|
||||
const prevIdx = i => (carouselImages - i)
|
||||
const len = carouselImages.length;
|
||||
const modIdx = i => (1 + (i + len) % len);
|
||||
</script>
|
||||
|
||||
<div class="mockup-window rounded-xl bg-base-200 shadow-secondary w-3/5 h-auto">
|
||||
<img class="inline dark:hidden" alt="dashboard screenshot" src="/images/dashboard-dark.webp" />
|
||||
<img class="hidden dark:inline" alt="dashboard screenshot" src="/images/dashboard-light.webp" />
|
||||
<div class="mockup-window rounded-xl bg-base-200 w-auto h-fit shadow-lg shadow-secondary">
|
||||
<div class="w-full carousel rounded-box">
|
||||
{#each carouselImages as image, i}
|
||||
<div id="img{modIdx(i)}" class="carousel-item relative w-full">
|
||||
<img src={image.src} class="w-full" alt={image.alt} />
|
||||
<div class="absolute flex justify-between transform -translate-y-1/2 left-5 right-5 top-1/2">
|
||||
<a href="#img{modIdx(i - 1)}" class="btn btn-circle">❮</a>
|
||||
<a href="#img{modIdx(i + 1)}" class="btn btn-circle">❯</a>
|
||||
</div>
|
||||
</div>
|
||||
{/each}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -3,17 +3,15 @@
|
||||
import {page} from "$app/stores";
|
||||
import Navbar from "$components/Navbar.svelte";
|
||||
import ProgressButtons from "./ProgressButtons.svelte";
|
||||
import {browser} from "$app/environment";
|
||||
import {onMount} from "svelte";
|
||||
import SocialShareMeta from "$components/SocialShareMeta.svelte";
|
||||
|
||||
const sidebarPages = [
|
||||
{section: "Getting Started", ref: "/docs/intro", label: "Introduction"},
|
||||
{ref: "/docs/installation", label: "Install"},
|
||||
{ref: "/docs/setup", label: "Setup"},
|
||||
{section: "Usage", ref: "/docs/apps", label: "Apps"},
|
||||
// {ref: "/docs/apps/create", label: "Create App", level: 1},
|
||||
{ref: "/docs/services", label: "Services"},
|
||||
{ref: "/docs/settings", label: "Settings"},
|
||||
// {ref: "/docs/settings", label: "Settings"},
|
||||
{section: "Maintenance", ref: "/docs/upgrading", label: "Upgrading"},
|
||||
{ref: "/docs/uninstall", label: "Uninstall"},
|
||||
{ref: "/docs/support", label: "Support"},
|
||||
@@ -25,10 +23,13 @@
|
||||
prevPage = (currentPage > 0) ? sidebarPages[currentPage - 1] : null;
|
||||
nextPage = (currentPage < sidebarPages.length - 1) ? sidebarPages[currentPage + 1] : null;
|
||||
}
|
||||
|
||||
$: pageTitle = `Shokku Docs - ${sidebarPages[currentPage].label}`;
|
||||
</script>
|
||||
|
||||
<svelte:head>
|
||||
<title>Shokku Docs - {sidebarPages[currentPage].label}</title>
|
||||
<title>{pageTitle}</title>
|
||||
<SocialShareMeta title={pageTitle} />
|
||||
</svelte:head>
|
||||
|
||||
<div class="flex flex-col h-screen">
|
||||
|
||||
@@ -28,8 +28,7 @@
|
||||
then be automatically built and deployed. See the Dokku docs on this method
|
||||
<a href={remoteRepoDocs}>here</a>.
|
||||
<br />
|
||||
If the repo is private, ensure you have configured access following the instructions
|
||||
<a href={`${base}/docs/settings`}>here</a>.
|
||||
If the repo is private, ensure you have configured access in the Settings page.
|
||||
</p>
|
||||
|
||||
<h2>Docker Image</h2>
|
||||
@@ -37,6 +36,6 @@
|
||||
This option enables pulling a Docker image. See the Dokku docs for caveats
|
||||
<a href={dockerImageDocs}>here</a>.
|
||||
<br />
|
||||
If the image is held in a private registry, ensure you have configured access by
|
||||
following the instructions <a href={`${base}/docs/settings`}>here</a>.
|
||||
If the image is held in a private registry, ensure you have configured access in the
|
||||
Settings page.
|
||||
</p>
|
||||
@@ -1,31 +1,24 @@
|
||||
<script>
|
||||
const bootstrapLink = "https://shokku.dev/bootstrap.sh";
|
||||
const scriptInstallCommands = [
|
||||
`wget "https://shokku.app/install.sh"`,
|
||||
`wget "${bootstrapLink}"`,
|
||||
`export SHOKKU_LETSENCRYPT_EMAIL="foo@example.com"`,
|
||||
`sudo bash install.sh`,
|
||||
]
|
||||
|
||||
const manualInstallCommands = [
|
||||
`todo`,
|
||||
]
|
||||
`bash bootstrap.sh`,
|
||||
];
|
||||
</script>
|
||||
|
||||
<h2>Prequisites</h2>
|
||||
<h2>Requirements</h2>
|
||||
<h3>Dokku</h3>
|
||||
<p>
|
||||
Shokku requires an underlying Dokku installation.
|
||||
You are recommended to manually install & configure it following
|
||||
<a href="https://dokku.com/docs/getting-started/installation/">the official documentation</a>.
|
||||
<br />
|
||||
If an existing installation is not detected during the setup process, it
|
||||
will be automatically installed and configured.
|
||||
</p>
|
||||
|
||||
<h3>SSL</h3>
|
||||
<p>
|
||||
Shokku will only work over HTTPS, so SSL must be configured. This can be via:
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Automatic (LetsEncrypt)</strong> <br />
|
||||
@@ -42,15 +35,23 @@
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<!--div class="collapse collapse-arrow border border-base-300 bg-base-100 rounded-box">
|
||||
<input type="checkbox" />
|
||||
<div class="collapse-title text-lg font-medium">
|
||||
Default installation configuration
|
||||
</div>
|
||||
<div class="collapse-content">
|
||||
<p>nginx, letsencrypt, etc</p>
|
||||
</div>
|
||||
</div-->
|
||||
<h3>System Requirements</h3>
|
||||
<p>
|
||||
Please refer to
|
||||
<a href="https://dokku.com/docs/getting-started/installation/#system-requirements">
|
||||
the operating systems supported by Dokku</a>.
|
||||
<br />
|
||||
Shokku is lightweight and will consume very little resources.
|
||||
</p>
|
||||
|
||||
<h4>DigitalOcean</h4>
|
||||
<p>
|
||||
For a cheap hosted server to try Shokku out, consider using DigitalOcean via this referral
|
||||
link. I get a kickback, and you get $200 in credit for 60 days - why not provision something beefy :)
|
||||
</p>
|
||||
<a target="_blank" href="https://www.digitalocean.com/?refcode=2fb615299eca&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
|
||||
<img src="https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%202.svg" alt="DigitalOcean Referral Badge" />
|
||||
</a>
|
||||
|
||||
<h2>Install Using Script</h2>
|
||||
|
||||
@@ -60,15 +61,6 @@
|
||||
{/each}
|
||||
</div>
|
||||
|
||||
<h2 class="flex items-center gap-2">
|
||||
<img alt="digitalocean icon" class="w-8 h-8"
|
||||
src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/digitalocean/digitalocean-original.svg" />
|
||||
DigitalOcean 1-Click Install
|
||||
</h2>
|
||||
<p>
|
||||
TODO: link to digitalocean marketplace
|
||||
</p>
|
||||
|
||||
<h2>Manual Installation</h2>
|
||||
<div class="collapse collapse-arrow border border-base-300 bg-base-100 rounded-box">
|
||||
<input type="checkbox" />
|
||||
@@ -78,12 +70,10 @@
|
||||
<div class="collapse-content">
|
||||
<p>
|
||||
If you don't feel comfortable using some random script from the internet,
|
||||
the installation can be manually performed fairly easily:
|
||||
the installation can be manually performed fairly easily.
|
||||
<br />
|
||||
Take a look at the <a href="{bootstrapLink}">bootstrap script</a>, it is
|
||||
commented and easy to follow.
|
||||
</p>
|
||||
<div class="mockup-code">
|
||||
{#each manualInstallCommands as cmd, i}
|
||||
<pre data-prefix="{i}" class="m-0 my-1 p-0"><code>{cmd}</code></pre>
|
||||
{/each}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,16 @@
|
||||
<p>
|
||||
Shokku is an interface for <a href="https://dokku.com" class="link">Dokku</a> - a
|
||||
self-hostable PaaS/alternative to Heroku.
|
||||
Shokku is an interface for <a href="https://dokku.com" class="link">Dokku</a> - an
|
||||
open source, self-hostable <a href="https://en.wikipedia.org/wiki/Platform_as_a_service">PaaS</a>
|
||||
(commercial options include <a href="https://heroku.com">Heroku</a>,
|
||||
<a href="https://fly.io">fly.io</a>, or <a href="https://render.com">Render</a>)
|
||||
<br />
|
||||
It is recommended you are somewhat familiar with the underlying Dokku project
|
||||
It is recommended you are familiar with the underlying Dokku project
|
||||
(<a href="https://dokku.com/docs" class="link">read the docs</a>).
|
||||
</p>
|
||||
|
||||
<p>
|
||||
It is not associated with Dokku.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
It is open-source and freely available, the repository is hosted on Github at
|
||||
Shokku is not associated with Dokku - but it is similarly open-source and
|
||||
freely available on Github at
|
||||
<a class="link" href="https://github.com/texm/shokku">texm/shokku</a>.
|
||||
</p>
|
||||
|
||||
@@ -24,15 +23,15 @@
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li>Works with your existing Dokku installation, or configures one during setup</li>
|
||||
<li>Deploys as an app via an existing Dokku installation</li>
|
||||
<li>Build, deploy, and manage almost any kind of application easily</li>
|
||||
<li>Easy creation of <code>Redis, PostgreSQL, MySQL, and MongoDB</code> services</li>
|
||||
<li>Reverse proxy and automatic SSL via LetsEncrypt</li>
|
||||
<li>Github Integration</li>
|
||||
<ul>
|
||||
<li>Single-user or organisation installation</li>
|
||||
<li>User management / Authentication</li>
|
||||
<li>Repo-aware smart suggestions</li>
|
||||
<li>todo: Repo-aware smart suggestions</li>
|
||||
</ul>
|
||||
<li>Optional API Access</li>
|
||||
<li>... and more, try it out!</li>
|
||||
</ul>
|
||||
@@ -45,6 +45,7 @@
|
||||
<h2>Linking a service</h2>
|
||||
<p>
|
||||
Services need to be <i>linked</i> to an app. Once this is done, the connection
|
||||
information will be available in the UI, and injected as an environment variable
|
||||
to the app (eg <code>REDIS_URL</code>)
|
||||
information will be available to the app as an environment variable
|
||||
(eg <code>REDIS_URL</code>). These can be viewed in the Environment Variables
|
||||
app page.
|
||||
</p>
|
||||
@@ -1 +0,0 @@
|
||||
<p>todo</p>
|
||||
@@ -1,17 +1,19 @@
|
||||
<script>
|
||||
const ghAppUrl = "https://docs.github.com/en/apps/creating-github-apps/creating-github-apps/about-apps"
|
||||
const manifestUrl = "https://docs.github.com/en/apps/creating-github-apps/creating-github-apps/creating-a-github-app-from-a-manifest";
|
||||
// TODO
|
||||
const codeManifestUrl = "https://github.com/texm/shokku"
|
||||
const codeManifestUrl = "https://github.com/texm/shokku/blob/main/ui/src/routes/setup/github/%2Bpage.svelte#L10-L28"
|
||||
</script>
|
||||
|
||||
<h2>Get Setup Key</h2>
|
||||
<h2>Setup Key</h2>
|
||||
<p>
|
||||
Once installation is finished, a <i>setup key</i> will be output to
|
||||
the console. Copy this, you will need it for the initial web setup.
|
||||
<br />
|
||||
This setup key is used to prevent any random internet stranger setting
|
||||
up your deployment before you do.
|
||||
</p>
|
||||
|
||||
<h2>Choose Setup Method</h2>
|
||||
<h2>Choose a Setup Method</h2>
|
||||
<h3>Github</h3>
|
||||
<p>
|
||||
Setting up with Github creates a <a href={ghAppUrl}>Github App</a> to
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 3.7 KiB |
BIN
web/static/images/share-card.png
Normal file
BIN
web/static/images/share-card.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
BIN
web/static/images/whale-boat-sm.png
Normal file
BIN
web/static/images/whale-boat-sm.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
BIN
web/static/images/whale-boat.png
Normal file
BIN
web/static/images/whale-boat.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
@@ -1,19 +1,13 @@
|
||||
import adapter from '@sveltejs/adapter-static';
|
||||
import { vitePreprocess } from '@sveltejs/kit/vite';
|
||||
const dev = process.argv.includes('dev');
|
||||
|
||||
/** @type {import('@sveltejs/kit').Config} */
|
||||
const config = {
|
||||
kit: {
|
||||
adapter: adapter({
|
||||
pages: 'build',
|
||||
assets: 'build',
|
||||
fallback: null,
|
||||
precompress: false,
|
||||
strict: true
|
||||
}),
|
||||
adapter: adapter(),
|
||||
paths: {
|
||||
// base: dev ? '' : '/shokku',
|
||||
base: process.env.NODE_ENV === "production" ? process.env.BASE_PATH : "",
|
||||
relative: false,
|
||||
},
|
||||
},
|
||||
preprocess: vitePreprocess(),
|
||||
|
||||
Reference in New Issue
Block a user