forked from glenux/mfm
Merge branch 'release/v0.1.0'
This commit is contained in:
commit
3d08966c73
29 changed files with 1856 additions and 119 deletions
48
.drone.yml
Normal file
48
.drone.yml
Normal file
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: default
|
||||
|
||||
steps:
|
||||
- name: build:binary
|
||||
image: crystallang/crystal:1.7.3
|
||||
volumes:
|
||||
- name: cache
|
||||
path: /_cache
|
||||
commands:
|
||||
- pwd
|
||||
- apt-get update && apt-get install -y cmake g++ libevent-dev libpcre3-dev libyaml-dev
|
||||
- shards install
|
||||
- shards build --production --static
|
||||
- strip bin/mfm
|
||||
- mkdir -p /_cache/bin
|
||||
- cp -r bin/mfm /_cache/bin/mfm_linux_amd64
|
||||
|
||||
- name: publish:tag
|
||||
image: curlimages/curl
|
||||
environment:
|
||||
PACKAGE_UPLOAD_URL: https://code.apps.glenux.net/api/packages/glenux/generic/mfm
|
||||
PACKAGE_BASENAME: mfm_linux_amd64
|
||||
PACKAGE_UPLOAD_TOKEN:
|
||||
from_secret: PACKAGE_UPLOAD_TOKEN
|
||||
when:
|
||||
ref:
|
||||
include:
|
||||
- refs/tags/**
|
||||
volumes:
|
||||
- name: cache
|
||||
path: /_cache
|
||||
commands:
|
||||
- env |grep DRONE
|
||||
- |
|
||||
curl -H "Authorization: token $PACKAGE_UPLOAD_TOKEN" \
|
||||
--upload-file /_cache/bin/mfm_amd64 \
|
||||
$PACKAGE_UPLOAD_URL/$DRONE_TAG/$PACKAGE_BASENAME
|
||||
|
||||
# FIXME: handle multi-arch
|
||||
# FIXME: publish only on tags
|
||||
|
||||
volumes:
|
||||
- name: cache
|
||||
temp: {}
|
||||
#
|
4
.gitattributes
vendored
Normal file
4
.gitattributes
vendored
Normal file
|
@ -0,0 +1,4 @@
|
|||
*.webm filter=lfs diff=lfs merge=lfs -text
|
||||
*.gif filter=lfs diff=lfs merge=lfs -text
|
||||
*.svg filter=lfs diff=lfs merge=lfs -text
|
||||
*.rec filter=lfs diff=lfs merge=lfs -text
|
6
.gitignore
vendored
6
.gitignore
vendored
|
@ -1,2 +1,8 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
.vagrant
|
||||
bin
|
||||
lib
|
||||
|
|
12
.reuse/dep5
Normal file
12
.reuse/dep5
Normal file
|
@ -0,0 +1,12 @@
|
|||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0
|
||||
Upstream-Name: Minimalist FUSE Manager (MFM)
|
||||
Upstream-Contact: Glenn Y. Rolland <glenux@glenux.net>
|
||||
Source: https://code.apps.glenux.net/glenux/mfm/
|
||||
|
||||
Files: shard.lock
|
||||
Copyright: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
License: GPL-3.0-or-later
|
||||
|
||||
Files: doc/output.*
|
||||
Copyright: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
License: GPL-3.0-or-later
|
674
LICENSES/GPL-3.0-or-later.txt
Normal file
674
LICENSES/GPL-3.0-or-later.txt
Normal file
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
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.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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 precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU 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. 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>.
|
4
Makefile
4
Makefile
|
@ -1,3 +1,7 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
all: build
|
||||
|
||||
|
|
135
README.md
135
README.md
|
@ -1,58 +1,117 @@
|
|||
# GX-Vault Manager
|
||||
<!--
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
-->
|
||||
|
||||
GX-Vault Manager is a Crystal-lang script that helps in managing encrypted vaults using `gocryptfs`. The script offers a user-friendly interface for mounting and unmounting vaults, providing real-time status and handling errors gracefully.
|
||||
# Minimalist Fuse Manager (MFM)
|
||||
|
||||
## Configuration
|
||||
MFM is a Crystal-lang CLI designed to streamline the management of various FUSE filesystems, such as sshfs, gocryptfs, httpdirfs, and more. Through its user-friendly interface, users can effortlessly mount and unmount filesystems, get real-time filesystem status, and handle errors proficiently.
|
||||
|
||||
The script uses a YAML configuration file, typically stored at `~/.config/gx-vault.yml`. This file contains details about the vaults, including their names and paths.
|
||||
## Prerequisites & Dependencies
|
||||
|
||||
## YAML File Format
|
||||
Before using MFM, make sure the following tools are installed on your system:
|
||||
|
||||
The configuration file consists of an array of vaults, with each vault having a name and an encrypted path. Below is the structure of the YAML file:
|
||||
- **gocryptfs**: <https://github.com/rfjakob/gocryptfs>
|
||||
- **sshfs**: <https://github.com/libfuse/sshfs>
|
||||
- **httpdirfs**: <https://github.com/fangfufu/httpdirfs>
|
||||
- **fzf**: <https://github.com/junegunn/fzf>
|
||||
|
||||
```yaml
|
||||
vaults:
|
||||
- name: "vault1"
|
||||
encrypted_path: "/absolute/path/to/vault1"
|
||||
|
||||
- name: "vault2"
|
||||
encrypted_path: "/absolute/path/to/vault2"
|
||||
|
||||
# Add more vaults as needed
|
||||
```
|
||||
To build from source, you'll also need:
|
||||
|
||||
## Fields Description
|
||||
- **crystal-lang**: <https://crystal-lang.org/>
|
||||
|
||||
- **vaults:** The root element containing an array of all defined vaults.
|
||||
## Installation
|
||||
|
||||
- **name:** The unique name of the vault. This is used for display and selection purposes.
|
||||
### 1. From Source
|
||||
|
||||
- **encrypted_path:** The absolute path to the directory where the encrypted data is stored. This path is used by `gocryptfs` for mounting the vault.
|
||||
1. Clone or download the source code.
|
||||
2. Navigate to the source directory.
|
||||
3. Run `shards install` to fetch dependencies.
|
||||
4. Compile using `shards build`.
|
||||
5. The compiled binary will be in the `bin` directory.
|
||||
|
||||
## Example
|
||||
### 2. Binary Download
|
||||
|
||||
Here is a sample configuration with two vaults named "Personal" and "Work":
|
||||
|
||||
```yaml
|
||||
vaults:
|
||||
- name: "Personal"
|
||||
encrypted_path: "/home/user/encrypted/personal"
|
||||
|
||||
- name: "Work"
|
||||
encrypted_path: "/home/user/encrypted/work"
|
||||
```
|
||||
Alternatively, download a pre-compiled binary version of MFM.
|
||||
|
||||
## Usage
|
||||
|
||||
Once the YAML configuration file is set up, run the script. It will read the configuration, and you can select a vault to mount or unmount using the `fzf` interactive selector. The status of each vault (whether it's open or closed) is displayed next to the vault's name.
|
||||
### Command Line Options
|
||||
|
||||
## Dependencies
|
||||
```
|
||||
Usage: mfm [options]
|
||||
|
||||
- gocryptfs
|
||||
- fzf
|
||||
- Crystal-lang
|
||||
- Other dependencies as per the Crystal-lang script
|
||||
Global options:
|
||||
-c, --config FILE Specify configuration file
|
||||
-h, --help Display this help
|
||||
|
||||
Commands:
|
||||
create Add a new filesystem
|
||||
delete Remove an existing filesystem
|
||||
edit Modify the configuration
|
||||
```
|
||||
|
||||
### Demo
|
||||
|
||||
<video src="https://code.apps.glenux.net/glenux/mfm/media/branch/develop/doc/output.webm" width="810" height="595" style="max-width: 100%;" controls="controls"></video>
|
||||
|
||||
## Configuration
|
||||
|
||||
MFM uses a YAML configuration file, typically found at `~/.config/mfm.yml`, to detail the filesystem names, types, and respective configurations.
|
||||
|
||||
### YAML File Format
|
||||
|
||||
```yaml
|
||||
version: "1"
|
||||
|
||||
global:
|
||||
mountpoint: "/home/user/mnt/{{name}}"
|
||||
|
||||
filesystems:
|
||||
- type: "gocryptfs"
|
||||
name: "Work - SSH Keys"
|
||||
encrypted_path: "/home/user/.ssh/keyring.work"
|
||||
|
||||
- type: "sshfs"
|
||||
name: "Personal - Media Server"
|
||||
remote_user: "user"
|
||||
remote_host: "mediaserver.local"
|
||||
remote_path: "/mnt/largedisk/music"
|
||||
remote_port: 22
|
||||
|
||||
- type: httpdirfs
|
||||
name: "Debian Repository"
|
||||
url: "http://ftp.debian.org/debian/"
|
||||
|
||||
# Add more filesystems as needed
|
||||
```
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
Contributing to MFM:
|
||||
|
||||
1. **Fork the Repository**: Start by forking MFM's repository.
|
||||
2. **Create a Feature Branch**: Develop each feature or fix in its own branch.
|
||||
3. **Commit Changes**: Provide clear and informative commit messages.
|
||||
4. **Run Tests**: Ensure that all features are operational.
|
||||
5. **Push to Your Fork**: Push your changes to your fork on GitHub.
|
||||
6. **Submit a Pull Request**: Begin a pull request to the main repository and explain your changes.
|
||||
7. **Review**: Await feedback from the maintainers and respond as necessary.
|
||||
|
||||
By contributing, you agree to our code of conduct and GPL-2 license terms.
|
||||
|
||||
## Authors and Contributors
|
||||
|
||||
- Glenn Y. Rolland - *Initial Work*
|
||||
|
||||
## Inspired By
|
||||
|
||||
- **Qasim**: A user-friendly FUSE manager. <https://code.apps.glenux.net/glenux/qasim>
|
||||
- **Sirikali**: A Qt/C++ GUI front-end for various FUSE filesystems like cryfs, gocryptfs, securefs, ecryptfs, and encfs. <https://mhogomchungu.github.io/sirikali/>
|
||||
|
||||
## License
|
||||
|
||||
GPL-2
|
||||
GNU GPL-3
|
||||
|
||||
|
|
34
Vagrantfile
vendored
Normal file
34
Vagrantfile
vendored
Normal file
|
@ -0,0 +1,34 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
# -*- mode: ruby -*-
|
||||
# vi: set ft=ruby :
|
||||
|
||||
Vagrant.configure('2') do |config|
|
||||
config.vm.box = 'debian/bookworm64'
|
||||
config.vm.box_check_update = false
|
||||
|
||||
config.vm.provider 'virtualbox' do |vb|
|
||||
vb.gui = false
|
||||
vb.memory = '4096'
|
||||
end
|
||||
|
||||
config.vm.provider "libvirt" do |lv|
|
||||
# lv.cpus = "2"
|
||||
lv.memory = "4096"
|
||||
# enable nested virtualization
|
||||
lv.nested = true
|
||||
lv.cpu_mode = "host-model"
|
||||
end
|
||||
|
||||
# config.vm.synced_folder ".", "/vagrant", type: "nfs", mount_options: ["vers=3,tcp"]
|
||||
# config.vm.synced_folder "../../exercises", "/exercises", type: "nfs", mount_options: ["vers=3,tcp"]
|
||||
|
||||
config.vm.define 'demo' do |machine|
|
||||
machine.vm.hostname = 'demo'
|
||||
|
||||
machine.vm.network 'forwarded_port', guest: 8080, host: 8080, host_ip: '127.0.0.1'
|
||||
machine.vm.network 'forwarded_port', guest: 80, host: 1080, host_ip: '127.0.0.1'
|
||||
end
|
||||
|
||||
config.vm.provision 'shell', path: 'scripts/vagrant.provision.sh'
|
||||
end
|
114
doc/SCRIPT.md
Normal file
114
doc/SCRIPT.md
Normal file
|
@ -0,0 +1,114 @@
|
|||
|
||||
# Minimalist FUSE Manager
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
Let's start by configuring `~/mnt/mfm.yml`!
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
We can add as many filesystems we want in the `filesystems:` list.
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
Each filesystem has a `type:` and specific configuration parameters
|
||||
|
||||
The current values supported by *mfm* are `gocryptfs`, `httpdirfs` and `sshfs`.
|
||||
|
||||
---
|
||||
|
||||
## Preparation
|
||||
|
||||
Before using *mfm*, lets have a look at the `~/mnt/` directory.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Preparation
|
||||
|
||||
Yes, it is empty!
|
||||
|
||||
Don't worry, the mountpoint will be created automatically.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
Ok. Now, simply run *mfm* and choose your favorite filesystem!
|
||||
|
||||
In this demo, I will choose `Public - Debian Repository` which is a remote web
|
||||
page hosting debian packages and registy catalog.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
Hmmm...
|
||||
|
||||
What happened?
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
A directory was created in `~/mnt`.
|
||||
|
||||
It is filled with files and directories from a remote system, in which we can
|
||||
navigate.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
Let's detach it now!
|
||||
|
||||
Simply run *mfm* again, and choose the same filesystem.
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
It is now detached, and the directory is empty again!
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
The *mfm* command works in the same way regardless of the filesystem selected.
|
||||
|
||||
It's simple, fast and efficient.
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
The *mfm* project is still in its infancy.
|
||||
|
||||
We're looking for contributors to test it, to improve it, to make it even more
|
||||
useful and enjoyable to use.
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
But if you're just a user, we're already happy.
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
Now it's your turn to use *mfm*!
|
||||
|
23
doc/demo.mfm.yml
Normal file
23
doc/demo.mfm.yml
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
|
||||
version: 1
|
||||
|
||||
global:
|
||||
mountpoint: "~/mnt"
|
||||
|
||||
filesystems:
|
||||
- type: gocryptfs
|
||||
name: "Personal - Encrypted Credentials"
|
||||
encrypted_path: "/path/to/credentials/vault"
|
||||
|
||||
- type: httpdirfs
|
||||
name: "Public - Remote Debian Repository"
|
||||
url: "http://ftp.debian.org/debian/"
|
||||
|
||||
- type: sshfs
|
||||
name: "Personal - Remote Media Server"
|
||||
remote_user: user
|
||||
remote_host: mediaserver.local
|
||||
remote_port: 22
|
||||
remote_path: "/remote/path/to/media"
|
||||
#
|
BIN
doc/output.gif
(Stored with Git LFS)
Normal file
BIN
doc/output.gif
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
doc/output.rec
(Stored with Git LFS)
Normal file
BIN
doc/output.rec
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
doc/output.svg
(Stored with Git LFS)
Normal file
BIN
doc/output.svg
(Stored with Git LFS)
Normal file
Binary file not shown.
BIN
doc/output.webm
(Stored with Git LFS)
Normal file
BIN
doc/output.webm
(Stored with Git LFS)
Normal file
Binary file not shown.
373
doc/record-output.sh
Normal file
373
doc/record-output.sh
Normal file
|
@ -0,0 +1,373 @@
|
|||
#!/bin/bash
|
||||
# shellcheck disable=SC2317
|
||||
|
||||
set -u
|
||||
|
||||
# parameters
|
||||
konsole=org.kde.konsole-2913641
|
||||
session=2
|
||||
SLEEP_LONG_READ="3"
|
||||
SLEEP_SHORT_READ="2"
|
||||
SLEEP_TRANSITION="0.4"
|
||||
SLEEP_COMMAND_BEFORE="0.4"
|
||||
SLEEP_COMMAND_AFTER="0.65"
|
||||
SLEEP_MICROPAUSE="0.25"
|
||||
SLEEP_TYPESPEED="0.10"
|
||||
|
||||
qtype() {
|
||||
qdbus "$konsole" "/Sessions/$session" sendText "$1"
|
||||
}
|
||||
|
||||
qrun() {
|
||||
qdbus "$konsole" "/Sessions/$session" runCommand "$1"
|
||||
}
|
||||
|
||||
qctrlb() {
|
||||
qdbus "$konsole" "/Sessions/$session" sendText $'\002'
|
||||
}
|
||||
|
||||
qctrlc() {
|
||||
qdbus "$konsole" "/Sessions/$session" sendText $'\003'
|
||||
}
|
||||
|
||||
|
||||
qtype_slow() {
|
||||
echo -n "$1" \
|
||||
| sed 's/\(.\)/\1\n/g' \
|
||||
| while IFS="" read -r X ; do qtype "$X" ; sleep "$SLEEP_TYPESPEED" ; done
|
||||
}
|
||||
|
||||
tmux_key() {
|
||||
qctrlb
|
||||
sleep 0.5
|
||||
qtype "$1"
|
||||
}
|
||||
|
||||
qtype_arrow_up() {
|
||||
qtype $'\033'
|
||||
qtype "[A"
|
||||
}
|
||||
|
||||
qtype_arrow_down() {
|
||||
qtype $'\033'
|
||||
qtype "[B"
|
||||
}
|
||||
|
||||
qtype_arrow_left() {
|
||||
qtype $'\033'
|
||||
qtype "[D"
|
||||
}
|
||||
|
||||
qtype_arrow_right() {
|
||||
qtype $'\033'
|
||||
qtype "[C"
|
||||
}
|
||||
|
||||
## cleanup
|
||||
|
||||
qctrlc
|
||||
tmux_key "d"
|
||||
qctrlc
|
||||
|
||||
qrun "clear"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "cd ~/src/mfm"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "cp doc/demo.mfm.yml ~/.config/mfm.yml"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "rm -f output.rec"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "tmux kill-session -t demo"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "mkdir -p /home/vagrant/mnt"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "fusermount -u \"/home/vagrant/mnt/Public - Remote Debian Repository\""
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "rm -fr \"/home/vagrant/mnt/Public - Remote Debian Repository\""
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "# cleanup done"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
## reset demo environment
|
||||
qrun "tmux new -s demo"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
tmux_key "c"
|
||||
qrun "cd ~/src/mfm"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "mdp --noslidenum doc/SCRIPT.md"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
|
||||
tmux_key "c"
|
||||
qrun "export PATH=\$PATH:~/src/mfm/bin"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "export FZF_DEFAULT_OPTS=\"--height 40% --layout=reverse --border\""
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "alias cat=\"batcat -p\""
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "cd ~/src/mfm"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun "clear"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
|
||||
tmux_key "1"
|
||||
tmux_key ":"
|
||||
qrun "set -g status off"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
|
||||
tmux_key "d"
|
||||
|
||||
## record
|
||||
qrun "asciinema rec --cols 80 --rows 24 -c 'tmux attach' output.rec"
|
||||
|
||||
# slide 1 (title)
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 2 (config file)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# cmd 2 (show config file)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
|
||||
tmux_key "2"
|
||||
qtype_slow "cat "
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "~/.config"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "/mfm.yml"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qrun ""
|
||||
sleep "$SLEEP_LONG_READ" # double
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
tmux_key "1"
|
||||
|
||||
# slide 3 (config options 1)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 4 (config options 2)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 5 (preparation - mnt)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# demo 5 (show mnt)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
|
||||
tmux_key "2"
|
||||
qtype_slow "cd "
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "~/mnt"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
tmux_key "1"
|
||||
|
||||
# slide 6 (preparation - empty mnt!)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 7 (usage - run)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# demo 7 (run mfm)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
|
||||
tmux_key "2"
|
||||
qtype_slow "m"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "f"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "m"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_arrow_down
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_arrow_down
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_arrow_up
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
tmux_key "1"
|
||||
|
||||
# slide 8 (usage - what?)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# demo 8 (usage - what : show mnt)
|
||||
tmux_key "2"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_slow "cd \"Pub"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype "lic - Remote Debian Repository\""
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_slow "cd pool"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_slow "cd main"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
tmux_key "1"
|
||||
|
||||
# slide 9 (usage - explanation)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 10 (usage - prepare for detach)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# demo 10 (run mfm for detach)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
|
||||
tmux_key "2"
|
||||
|
||||
qtype_slow "cd ~/mnt/"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
|
||||
qtype_slow "m"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "f"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_slow "m"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_arrow_down
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_arrow_down
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype_arrow_up
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_slow "cd \"Pub"
|
||||
sleep "$SLEEP_MICROPAUSE"
|
||||
qtype "lic - Remote Debian Repository\""
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_slow "ls"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_SHORT_READ"
|
||||
|
||||
qtype_slow "ls -la"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
sleep "$SLEEP_COMMAND_BEFORE"
|
||||
qtype $'\015'
|
||||
sleep "$SLEEP_COMMAND_AFTER"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
tmux_key "1"
|
||||
|
||||
# slide 11 (usage - detached)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
|
||||
# slide 12 (conclusion)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 13 (conclusion)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 14 (conclusion)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# slide 15 (conclusion)
|
||||
qtype " "
|
||||
sleep "$SLEEP_TRANSITION"
|
||||
sleep "$SLEEP_LONG_READ"
|
||||
|
||||
# detach and clean
|
||||
tmux_key "d"
|
||||
|
||||
qrun "tmux kill-session -t demo"
|
||||
qrun "termtosvg render output.rec output.svg"
|
||||
|
||||
qrun "# success!"
|
||||
|
||||
exit 0
|
||||
|
|
@ -1,6 +1,11 @@
|
|||
#!/bin/sh
|
||||
# vim: set ft=sh :
|
||||
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
set -e
|
||||
set -u
|
||||
|
72
scripts/vagrant.provision.sh
Normal file
72
scripts/vagrant.provision.sh
Normal file
|
@ -0,0 +1,72 @@
|
|||
#!/bin/sh
|
||||
|
||||
# install crystal
|
||||
set -e
|
||||
set -u
|
||||
|
||||
USER="$(test -d /vagrant && echo "vagrant" || echo "debian")"
|
||||
HOSTNAME="$(hostname)"
|
||||
|
||||
export DEBIAN_FRONTEND=noninteractive
|
||||
|
||||
echo "Installing required system packages"
|
||||
apt-get update --allow-releaseinfo-change
|
||||
apt-get install -y \
|
||||
apt-transport-https \
|
||||
ca-certificates \
|
||||
git \
|
||||
curl \
|
||||
wget \
|
||||
vim \
|
||||
gnupg2 \
|
||||
software-properties-common
|
||||
|
||||
echo "Installing recording requirements"
|
||||
apt-get install -y \
|
||||
tmux \
|
||||
mdp \
|
||||
bat \
|
||||
asciinema \
|
||||
termtosvg
|
||||
|
||||
echo "Installing mfm requirements"
|
||||
apt-get install -y \
|
||||
fzf \
|
||||
sshfs \
|
||||
httpdirfs \
|
||||
libyaml-0-2 \
|
||||
libyaml-dev \
|
||||
libpcre3-dev \
|
||||
libevent-dev
|
||||
|
||||
#!/bin/sh
|
||||
|
||||
set -e
|
||||
set -u
|
||||
|
||||
USER="$(test -d /vagrant && echo "vagrant" || echo "debian")"
|
||||
CLUSTERS_DIR=/home/$USER/clusters
|
||||
|
||||
# Installation de kompose
|
||||
if [ ! -f /usr/local/bin/kompose ]; then
|
||||
DL="$(mktemp)"
|
||||
curl \
|
||||
-L https://github.com/kubernetes/kompose/releases/download/v1.22.0/kompose-linux-amd64 \
|
||||
-o "$DL"
|
||||
chmod +x "$DL"
|
||||
mv "$DL" /usr/local/bin/kompose
|
||||
fi
|
||||
|
||||
# Installing asdf
|
||||
su - "$USER" -c "git config --global advice.detachedHead false"
|
||||
su - "$USER" -c "rm -rf ~/.asdf"
|
||||
su - "$USER" -c "git clone --quiet https://github.com/asdf-vm/asdf.git \
|
||||
~/.asdf \
|
||||
--branch v0.8.0"
|
||||
su - "$USER" -c "echo '. \$HOME/.asdf/asdf.sh' >> ~/.bashrc"
|
||||
|
||||
su - "$USER" -c "source \$HOME/.asdf/asdf.sh \
|
||||
&& asdf plugin add crystal 2>&1 \
|
||||
&& asdf install crystal 1.7.3 >/dev/null 2>&1 \
|
||||
&& asdf global crystal 1.7.3"
|
||||
|
6
shard.lock
Normal file
6
shard.lock
Normal file
|
@ -0,0 +1,6 @@
|
|||
version: 2.0
|
||||
shards:
|
||||
shellwords:
|
||||
git: https://github.com/sztheory/shellwords-crystal.git
|
||||
version: 0.1.0
|
||||
|
16
shard.yml
16
shard.yml
|
@ -1,8 +1,14 @@
|
|||
name: gx-vault
|
||||
---
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
name: Minimalist FUSE Manager
|
||||
version: 0.1.0
|
||||
|
||||
targets:
|
||||
gx-vault:
|
||||
mfm:
|
||||
main: src/main.cr
|
||||
|
||||
# authors:
|
||||
|
@ -11,6 +17,10 @@ targets:
|
|||
# description: |
|
||||
# Short description of gx-vault
|
||||
|
||||
dependencies:
|
||||
shellwords:
|
||||
github: szTheory/shellwords-crystal
|
||||
|
||||
# dependencies:
|
||||
# pg:
|
||||
# github: will/crystal-pg
|
||||
|
@ -20,4 +30,4 @@ targets:
|
|||
# webmock:
|
||||
# github: manastech/webmock.cr
|
||||
|
||||
# license: MIT
|
||||
license: GPL-3
|
||||
|
|
110
src/cli.cr
110
src/cli.cr
|
@ -1,42 +1,108 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "option_parser"
|
||||
require "./config"
|
||||
require "./fzf"
|
||||
|
||||
module GX
|
||||
class Cli
|
||||
@home_dir : String
|
||||
|
||||
@config : Config
|
||||
|
||||
def initialize()
|
||||
# Main execution starts here
|
||||
if !ENV["HOME"]?
|
||||
raise "Home directory not found"
|
||||
end
|
||||
@home_dir = ENV["HOME"]
|
||||
@config = Config.new(File.join(@home_dir, ".config/gx-vault.yml"))
|
||||
@config = Config.new
|
||||
|
||||
## FIXME: check that FZF is installed
|
||||
end
|
||||
|
||||
def run()
|
||||
# Correcting the fzf interaction part
|
||||
names_display = @config.vaults.map do |vault|
|
||||
vault.mounted? ? "#{vault.name} [#{ "open".colorize(:green) }]" : vault.name
|
||||
def parse_command_line(args)
|
||||
# update
|
||||
add_args = { name: "", path: "" }
|
||||
delete_args = { name: "" }
|
||||
pparser = OptionParser.new do |parser|
|
||||
parser.banner = "Usage: #{PROGRAM_NAME} [options]\n\nGlobal options"
|
||||
|
||||
parser.on("-c", "--config FILE", "Set configuration file") do |path|
|
||||
@config.path = path
|
||||
end
|
||||
parser.on("-h", "--help", "Show this help") do |flag|
|
||||
STDOUT.puts parser
|
||||
exit(0)
|
||||
end
|
||||
|
||||
parser.separator("\nCommands")
|
||||
parser.on("create", "Create vault") do
|
||||
@config.mode = Config::Mode::Add
|
||||
|
||||
parser.banner = "Usage: #{PROGRAM_NAME} create [options]\n\nGlobal options"
|
||||
parser.separator("\nCommand options")
|
||||
|
||||
parser.on("-n", "--name", "Set vault name") do |name|
|
||||
add_args = add_args.merge({ name: name })
|
||||
end
|
||||
parser.on("-p", "--path", "Set vault encrypted path") do |path|
|
||||
add_args = add_args.merge({ path: path })
|
||||
end
|
||||
end
|
||||
|
||||
parser.on("delete", "Delete vault") do
|
||||
@config.mode = Config::Mode::Add
|
||||
|
||||
parser.banner = "Usage: #{PROGRAM_NAME} delete [options]\n\nGlobal options"
|
||||
parser.separator("\nCommand options")
|
||||
|
||||
parser.on("-n", "--name", "Set vault name") do |name|
|
||||
delete_args = delete_args.merge({ name: name })
|
||||
end
|
||||
end
|
||||
|
||||
parser.on("edit", "Edit configuration") do |flag|
|
||||
@config.mode = Config::Mode::Edit
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
selected_vault_name = Fzf.run(names_display.sort)
|
||||
puts ">> #{selected_vault_name}".colorize(:yellow)
|
||||
selected_vault = @config.vaults.find { |v| v.name == selected_vault_name }
|
||||
|
||||
if selected_vault
|
||||
selected_vault.mounted? ? selected_vault.unmount : selected_vault.mount
|
||||
else
|
||||
STDERR.puts "Vault not found.".colorize(:red)
|
||||
end
|
||||
|
||||
|
||||
pparser.parse(args)
|
||||
end
|
||||
|
||||
def run()
|
||||
@config.load_from_file
|
||||
|
||||
names_display = {} of String => NamedTuple(filesystem: Filesystem, ansi_name: String)
|
||||
@config.filesystems.each do |filesystem|
|
||||
fs_str = filesystem.type.ljust(12,' ')
|
||||
result_name =
|
||||
if filesystem.mounted?
|
||||
"#{fs_str} #{filesystem.name} [open]"
|
||||
else
|
||||
"#{fs_str} #{filesystem.name}"
|
||||
end
|
||||
ansi_name =
|
||||
if filesystem.mounted?
|
||||
"#{fs_str.colorize(:dark_gray)} #{filesystem.name} [#{ "open".colorize(:green) }]"
|
||||
else
|
||||
"#{fs_str.colorize(:dark_gray)} #{filesystem.name}"
|
||||
end
|
||||
|
||||
names_display[result_name] = {
|
||||
filesystem: filesystem,
|
||||
ansi_name: ansi_name
|
||||
}
|
||||
end
|
||||
|
||||
result_filesystem_name = Fzf.run(names_display.values.map(&.[:ansi_name]).sort)
|
||||
selected_filesystem = names_display[result_filesystem_name][:filesystem]
|
||||
puts ">> #{selected_filesystem.name}".colorize(:yellow)
|
||||
|
||||
if selected_filesystem
|
||||
selected_filesystem.mounted? ? selected_filesystem.unmount : selected_filesystem.mount
|
||||
else
|
||||
STDERR.puts "Vault not found: #{selected_filesystem}.".colorize(:red)
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
@ -1,24 +1,63 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "./vault"
|
||||
require "./filesystems"
|
||||
|
||||
module GX
|
||||
class Config
|
||||
getter vaults : Array(Vault)
|
||||
class Config
|
||||
enum Mode
|
||||
Add
|
||||
Edit
|
||||
Run
|
||||
end
|
||||
|
||||
def initialize(config_path : String)
|
||||
@vaults = [] of Vault
|
||||
load_vaults(config_path)
|
||||
end
|
||||
record NoArgs
|
||||
record AddArgs, name : String, path : String
|
||||
record DelArgs, name : String
|
||||
|
||||
private def load_vaults(config_path : String)
|
||||
yaml_data = YAML.parse(File.read(config_path))
|
||||
vaults_data = yaml_data["vaults"].as_a
|
||||
getter filesystems : Array(Filesystem)
|
||||
getter home_dir : String
|
||||
property mode : Mode
|
||||
property path : String
|
||||
property args : AddArgs.class | DelArgs.class | NoArgs.class
|
||||
|
||||
vaults_data.each do |vault_data|
|
||||
name = vault_data["name"].as_s
|
||||
encrypted_path = vault_data["encrypted_path"].as_s
|
||||
@vaults << Vault.new(name, encrypted_path, "#{name}.Open")
|
||||
DEFAULT_CONFIG_PATH = "mfm.yml"
|
||||
|
||||
def initialize()
|
||||
if !ENV["HOME"]?
|
||||
raise "Home directory not found"
|
||||
end
|
||||
@home_dir = ENV["HOME"]
|
||||
|
||||
@mode = Mode::Run
|
||||
@filesystems = [] of Filesystem
|
||||
@path = File.join(@home_dir, ".config", DEFAULT_CONFIG_PATH)
|
||||
@args = NoArgs
|
||||
end
|
||||
|
||||
def load_from_file
|
||||
@filesystems = [] of Filesystem
|
||||
|
||||
if !File.exists? @path
|
||||
STDERR.puts "Error: file #{@path} does not exist!".colorize(:red)
|
||||
exit(1)
|
||||
end
|
||||
load_filesystems(@path)
|
||||
end
|
||||
|
||||
private def load_filesystems(config_path : String)
|
||||
yaml_data = YAML.parse(File.read(config_path))
|
||||
vaults_data = yaml_data["filesystems"].as_a
|
||||
|
||||
vaults_data.each do |filesystem_data|
|
||||
type = filesystem_data["type"].as_s
|
||||
name = filesystem_data["name"].as_s
|
||||
# encrypted_path = filesystem_data["encrypted_path"].as_s
|
||||
@filesystems << Filesystem.from_yaml(filesystem_data.to_yaml)
|
||||
# @filesystems << Filesystem.new(name, encrypted_path, "#{name}.Open")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
9
src/filesystems.cr
Normal file
9
src/filesystems.cr
Normal file
|
@ -0,0 +1,9 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "./filesystems/gocryptfs"
|
||||
require "./filesystems/sshfs"
|
||||
require "./filesystems/httpdirfs"
|
||||
require "./filesystems/filesystem"
|
42
src/filesystems/filesystem.cr
Normal file
42
src/filesystems/filesystem.cr
Normal file
|
@ -0,0 +1,42 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "yaml"
|
||||
|
||||
module GX
|
||||
abstract class Filesystem
|
||||
include YAML::Serializable
|
||||
|
||||
use_yaml_discriminator "type", {
|
||||
gocryptfs: GoCryptFS,
|
||||
sshfs: SshFS,
|
||||
httpdirfs: HttpDirFS
|
||||
}
|
||||
|
||||
property type : String
|
||||
end
|
||||
|
||||
module GenericFilesystem
|
||||
def unmount
|
||||
system("fusermount -u #{mount_dir.shellescape}")
|
||||
puts "Filesystem #{name} is now closed.".colorize(:green)
|
||||
end
|
||||
|
||||
def mount(&block)
|
||||
Dir.mkdir_p(mount_dir) unless Dir.exists?(mount_dir)
|
||||
if mounted?
|
||||
puts "Already mounted. Skipping.".colorize(:yellow)
|
||||
return
|
||||
end
|
||||
|
||||
yield
|
||||
|
||||
puts "Filesystem #{name} is now available on #{mount_dir}".colorize(:green)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
require "./gocryptfs"
|
||||
require "./sshfs"
|
47
src/filesystems/gocryptfs.cr
Normal file
47
src/filesystems/gocryptfs.cr
Normal file
|
@ -0,0 +1,47 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "shellwords"
|
||||
require "./filesystem"
|
||||
|
||||
module GX
|
||||
class GoCryptFS < Filesystem
|
||||
getter name : String = ""
|
||||
getter encrypted_path : String = ""
|
||||
|
||||
@[YAML::Field(key: "mount_dir", ignore: true)]
|
||||
getter mount_dir : String = ""
|
||||
|
||||
include GenericFilesystem
|
||||
|
||||
def after_initialize()
|
||||
home_dir = ENV["HOME"] || raise "Home directory not found"
|
||||
@mount_dir = File.join(home_dir, "mnt/#{@name}.Open")
|
||||
end
|
||||
|
||||
def mounted? : Bool
|
||||
`mount`.includes?("#{encrypted_path} on #{mount_dir}")
|
||||
end
|
||||
|
||||
def mount
|
||||
super do
|
||||
input = STDIN
|
||||
output = STDOUT
|
||||
error = STDERR
|
||||
process = Process.new(
|
||||
"gocryptfs",
|
||||
["-idle", "15m", encrypted_path, mount_dir],
|
||||
input: input,
|
||||
output: output,
|
||||
error: error
|
||||
)
|
||||
unless process.wait.success?
|
||||
puts "Error mounting the vault".colorize(:red)
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
48
src/filesystems/httpdirfs.cr
Normal file
48
src/filesystems/httpdirfs.cr
Normal file
|
@ -0,0 +1,48 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "shellwords"
|
||||
require "./filesystem"
|
||||
|
||||
module GX
|
||||
class HttpDirFS < Filesystem
|
||||
getter name : String = ""
|
||||
getter url : String = ""
|
||||
|
||||
@[YAML::Field(key: "mount_dir", ignore: true)]
|
||||
getter mount_dir : String = ""
|
||||
|
||||
include GenericFilesystem
|
||||
|
||||
def after_initialize()
|
||||
home_dir = ENV["HOME"] || raise "Home directory not found"
|
||||
@mount_dir = File.join(home_dir, "mnt/#{@name}")
|
||||
end
|
||||
|
||||
def mounted? : Bool
|
||||
`mount`.includes?("httpdirfs on #{mount_dir}")
|
||||
end
|
||||
|
||||
def mount
|
||||
super do
|
||||
input = STDIN
|
||||
output = STDOUT
|
||||
error = STDERR
|
||||
process = Process.new(
|
||||
"httpdirfs",
|
||||
["#{url}", mount_dir],
|
||||
input: input,
|
||||
output: output,
|
||||
error: error
|
||||
)
|
||||
unless process.wait.success?
|
||||
puts "Error mounting the filesystem".colorize(:red)
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
49
src/filesystems/sshfs.cr
Normal file
49
src/filesystems/sshfs.cr
Normal file
|
@ -0,0 +1,49 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "shellwords"
|
||||
require "./filesystem"
|
||||
|
||||
module GX
|
||||
class SshFS < Filesystem
|
||||
getter name : String = ""
|
||||
getter remote_path : String = ""
|
||||
getter remote_user : String = ""
|
||||
getter remote_host : String = ""
|
||||
|
||||
@[YAML::Field(key: "mount_dir", ignore: true)]
|
||||
getter mount_dir : String = ""
|
||||
|
||||
include GenericFilesystem
|
||||
|
||||
def after_initialize()
|
||||
home_dir = ENV["HOME"] || raise "Home directory not found"
|
||||
@mount_dir = File.join(home_dir, "mnt/#{@name}")
|
||||
end
|
||||
|
||||
def mounted? : Bool
|
||||
`mount`.includes?("#{remote_user}@#{remote_host}:#{remote_path} on #{mount_dir}")
|
||||
end
|
||||
|
||||
def mount
|
||||
super do
|
||||
input = STDIN
|
||||
output = STDOUT
|
||||
error = STDERR
|
||||
process = Process.new(
|
||||
"sshfs",
|
||||
["#{remote_user}@#{remote_host}:#{remote_path}", mount_dir],
|
||||
input: input,
|
||||
output: output,
|
||||
error: error
|
||||
)
|
||||
unless process.wait.success?
|
||||
puts "Error mounting the filesystem".colorize(:red)
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
17
src/fzf.cr
17
src/fzf.cr
|
@ -1,3 +1,7 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
module GX
|
||||
class Fzf
|
||||
|
@ -11,8 +15,17 @@ module GX
|
|||
error = STDERR
|
||||
process = Process.new("fzf", ["--ansi"], input: input, output: output, error: error)
|
||||
|
||||
unless process.wait.success?
|
||||
STDERR.puts "Error executing fzf: #{error.to_s.strip}".colorize(:red)
|
||||
status = process.wait
|
||||
case status.exit_code
|
||||
when 0
|
||||
when 1
|
||||
STDERR.puts "No match".colorize(:red)
|
||||
exit(1)
|
||||
when 130
|
||||
STDERR.puts "Interrupted".colorize(:red)
|
||||
exit(1)
|
||||
else # includes retcode = 2 (error)
|
||||
STDERR.puts "Error executing fzf: #{error.to_s.strip} (#{status.exit_code})".colorize(:red)
|
||||
exit(1)
|
||||
end
|
||||
|
||||
|
|
|
@ -1,12 +1,18 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
||||
|
||||
require "yaml"
|
||||
require "colorize"
|
||||
require "json"
|
||||
|
||||
require "./vault"
|
||||
require "./filesystems/gocryptfs"
|
||||
require "./config"
|
||||
require "./cli"
|
||||
|
||||
app = GX::Cli.new
|
||||
app.parse_command_line(ARGV)
|
||||
app.run
|
||||
|
||||
|
||||
|
|
38
src/vault.cr
38
src/vault.cr
|
@ -1,38 +0,0 @@
|
|||
module GX
|
||||
class Vault
|
||||
getter name : String
|
||||
getter encrypted_path : String
|
||||
getter mount_dir : String
|
||||
|
||||
def initialize(@name, @encrypted_path, mount_name : String)
|
||||
home_dir = ENV["HOME"] || raise "Home directory not found"
|
||||
@mount_dir = File.join(home_dir, "mnt/#{mount_name}")
|
||||
end
|
||||
|
||||
def mounted? : Bool
|
||||
`mount`.includes?("#{encrypted_path} on #{mount_dir}")
|
||||
end
|
||||
|
||||
def mount
|
||||
Dir.mkdir_p(mount_dir) unless Dir.exists?(mount_dir)
|
||||
|
||||
if mounted?
|
||||
puts "Already mounted. Skipping.".colorize(:yellow)
|
||||
else
|
||||
input = STDIN
|
||||
output = STDOUT
|
||||
error = STDERR
|
||||
process = Process.new("gocryptfs", ["-idle", "15m", encrypted_path, mount_dir], input: input, output: output, error: error)
|
||||
unless process.wait.success?
|
||||
puts "Error mounting the vault".colorize(:red)
|
||||
return
|
||||
end
|
||||
puts "Vault #{name} is now available on #{mount_dir}".colorize(:green)
|
||||
end
|
||||
end
|
||||
def unmount
|
||||
`fusermount -u #{mount_dir}`
|
||||
puts "Vault #{name} is now closed.".colorize(:green)
|
||||
end
|
||||
end
|
||||
end
|
Loading…
Reference in a new issue