Skip to content

Commit a3577b7

Browse files
JMSDOnlineJMSDOnline
committed
enh: adjustments and corrections per new directory structure and code refactor
changelog: enhancements
1 parent 859fad9 commit a3577b7

20 files changed

+237
-230
lines changed

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Contributing
22

3-
> VStacklet is an open source project licensed using the The MIT License.
3+
> vStacklet is an open source project licensed using the The MIT License.
44
> This project has been forked and completely rewritten from [Quick LEMP](https://github.com/jbradach/quick-lemp/).
55
> Though the two are not the same and are entirely different, vStacklet has drawn inspiration from Quick LEMP and is grateful for the work that has been done.
6-
> I appreciate pull requesets as well as other types of contributions.
6+
> I appreciate pull requesets as well as other types of contributions. Any contributions, suggestions, or comments are welcome!
77
88
## Documentation
99

10-
Documentation is available at: [/docs/](https://github.com/JMSDOnline/vstacklet/tree/development/docs)
11-
- :book: [vStacklet Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/setup/vstacklet.sh.md)
12-
- :book: [vStacklet Server Stack Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/setup/vstacklet-server-stack.sh.md)
13-
- :book: [vStacklet www-permissions.sh) Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/www-permissions.sh.md)
14-
- :book: [vStacklet VS-Perms (www-permissions-standalone.sh) Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/www-permissions-standalone.sh.md)
15-
- :book: [vStacklet VS-Backup (vs-backup) Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/backup/vs-backup.md)
16-
- :book: [vStacklet VS-Backup (vstacklet-backup-standalone.sh) Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/backup/vstacklet-backup-standalone.sh.md)
10+
Documentation is available at: [/docs/](https://github.com/JMSDOnline/vstacklet/tree/main/docs)
11+
- :book: [vStacklet Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/setup/vstacklet.sh.md)
12+
- :book: [vStacklet Server Stack Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/setup/vstacklet-server-stack.sh.md)
13+
- :book: [vStacklet www-permissions.sh) Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/www-permissions.sh.md)
14+
- :book: [vStacklet VS-Perms (www-permissions-standalone.sh) Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/www-permissions-standalone.sh.md)
15+
- :book: [vStacklet VS-Backup (vs-backup) Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/backup/vs-backup.md)
16+
- :book: [vStacklet VS-Backup (vstacklet-backup-standalone.sh) Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/backup/vstacklet-backup-standalone.sh.md)
1717

1818
## How to Contribute
1919

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
## Script status
1212

13-
Version: v3.1.1.745
14-
Build: 745
13+
Version: v3.1.1.746
14+
Build: 746
1515

1616
[![MIT License](https://img.shields.io/badge/license-MIT%20License-blue.svg?style=flat-square)](https://github.com/JMSDOnline/vstacklet/blob/main/LICENSE)
1717

‎bin/backup/backup-cleanup.sh‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
################################################################################
33
# <START METADATA>
44
# @file_name: backup-cleanup.sh
5-
# @version: 3.1.1105
5+
# @version: 3.1.1106
66
# @description: This script will add a new www-data group on your server
77
# and set permissions for ${www_root:-/var/www/html}.
88
# Please ensure you have read the documentation before continuing.
@@ -53,7 +53,7 @@
5353
################################################################################
5454
# @name: vstacklet::backup::args() (3)
5555
# process options
56-
# @description: Process the options passed to the script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/backup-cleanup.sh#L66-L117)
56+
# @description: Process the options passed to the script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/backup-cleanup.sh#L66-L117)
5757
#
5858
# notes:
5959
# - This script function is responsible for processing the options passed to the
@@ -118,7 +118,7 @@ vstacklet::backup::args() {
118118

119119
##################################################################################
120120
# @name: vstacklet::environment::functions (2)
121-
# @description: Stage various functions for the setup environment. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/backup-cleanup.sh#L125-L204)
121+
# @description: Stage various functions for the setup environment. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/backup-cleanup.sh#L125-L204)
122122
# @script-note: This function is required for the installation of the vStacklet software.
123123
# @break
124124
##################################################################################
@@ -205,7 +205,7 @@ vstacklet::environment::functions() {
205205

206206
##################################################################################
207207
# @name: vstacklet::environment::checkroot (1)
208-
# @description: Check if the user is root. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/backup-cleanup.sh#L211-L216)
208+
# @description: Check if the user is root. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/backup-cleanup.sh#L211-L216)
209209
# @break
210210
##################################################################################
211211
vstacklet::environment::checkroot() {
@@ -217,7 +217,7 @@ vstacklet::environment::checkroot() {
217217

218218
##################################################################################
219219
# @name: vstacklet::backup::clean (4)
220-
# @description: Main function for cleaning up backups. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/backup-cleanup.sh#L223-L244)
220+
# @description: Main function for cleaning up backups. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/backup-cleanup.sh#L223-L244)
221221
# @break
222222
##################################################################################
223223
vstacklet::backup::clean() {
@@ -245,7 +245,7 @@ vstacklet::backup::clean() {
245245

246246
##################################################################################
247247
# @name: vstacklet::backup::usage
248-
# @description: Display usage information for the script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/backup-cleanup.sh#L251-L280)
248+
# @description: Display usage information for the script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/backup-cleanup.sh#L251-L280)
249249
# @break
250250
##################################################################################
251251
vstacklet::backup::usage() {

‎bin/backup/vs-backup‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
################################################################################
33
# <START METADATA>
44
# @file_name: vs-backup
5-
# @version: 3.1.1147
5+
# @version: 3.1.1148
66
# @description: This script will allow you to backup your vStacklet server
77
# files and databases.
88
#
@@ -15,8 +15,8 @@
1515
# This script will backup your database and files.
1616
# Please ensure you have read the documentation before continuing.
1717
#
18-
# - [vStacklet Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/setup/vstacklet.sh.md)
19-
# - [vStacklet Server Stack Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/setup/vstacklet-server-stack.sh.md)
18+
# - [vStacklet Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/setup/vstacklet.sh.md)
19+
# - [vStacklet Server Stack Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/setup/vstacklet-server-stack.sh.md)
2020
#
2121
# This script will do the following:
2222
# - Backup your database.
@@ -64,7 +64,7 @@
6464
# <END METADATA>
6565
################################################################################
6666
# @name: vstacklet::environment::functions (2)
67-
# @description: Stage various functions for the setup environment. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L70-L149)
67+
# @description: Stage various functions for the setup environment. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L70-L149)
6868
# @break
6969
##################################################################################
7070
vstacklet::environment::functions() {
@@ -150,7 +150,7 @@ vstacklet::environment::functions() {
150150

151151
##################################################################################
152152
# @name: vstacklet::environment::checkroot (1)
153-
# @description: Check if the user is root. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L156-L161)
153+
# @description: Check if the user is root. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L156-L161)
154154
# @break
155155
##################################################################################
156156
vstacklet::environment::checkroot() {
@@ -162,7 +162,7 @@ vstacklet::environment::checkroot() {
162162

163163
##################################################################################
164164
# @name: vstacklet::backup::variables (3)
165-
# @description: Set the variables for the backup. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L168-L297)
165+
# @description: Set the variables for the backup. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L168-L297)
166166
# @break
167167
##################################################################################
168168
vstacklet::backup::variables() {
@@ -298,7 +298,7 @@ vstacklet::backup::variables() {
298298

299299
##################################################################################
300300
# @name: vstacklet::backup::default::variables (4)
301-
# @description: The variables used in the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L304-L351)
301+
# @description: The variables used in the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L304-L351)
302302
# @break
303303
##################################################################################
304304
vstacklet::backup::default::variables() {
@@ -352,7 +352,7 @@ vstacklet::backup::default::variables() {
352352

353353
##################################################################################
354354
# @name: vstacklet::backup::main::checks (5)
355-
# @description: The checks used in the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L358-L391)
355+
# @description: The checks used in the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L358-L391)
356356
# @break
357357
##################################################################################
358358
vstacklet::backup::main::checks() {
@@ -392,7 +392,7 @@ vstacklet::backup::main::checks() {
392392

393393
##################################################################################
394394
# @name: vstacklet::intro (6)
395-
# @description: Prints the intro message. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L398-L415)
395+
# @description: Prints the intro message. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L398-L415)
396396
# @break
397397
##################################################################################
398398
vstacklet::intro() {
@@ -402,7 +402,7 @@ vstacklet::intro() {
402402
vstacklet::shell::text::white "Please ensure you have read the documentation before continuing."
403403
vstacklet::shell::misc::nl
404404
vstacklet::shell::text::white "Documentation can be found at:"
405-
vstacklet::shell::text::white "https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/backup/vs-backup.md"
405+
vstacklet::shell::text::white "https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/backup/vs-backup.md"
406406
vstacklet::shell::misc::nl
407407
vstacklet::ask::continue
408408
}
@@ -416,7 +416,7 @@ vstacklet::ask::continue() {
416416

417417
##################################################################################
418418
# @name: vstacklet::backup::files (7)
419-
# @description: Backup the specified files. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L422-L465)
419+
# @description: Backup the specified files. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L422-L465)
420420
# @break
421421
##################################################################################
422422
vstacklet::backup::files() {
@@ -466,7 +466,7 @@ vstacklet::backup::files() {
466466

467467
################################################################################
468468
# @name: vstacklet::backup::database (8)
469-
# @description: Backup a database. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L485-L524)
469+
# @description: Backup a database. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L485-L524)
470470
#
471471
# note: This function will additionally package the database backup into a tarball
472472
# and compress it on the fly, then encrypt it. The tarball will be moved to the
@@ -526,7 +526,7 @@ vstacklet::backup::database() {
526526
##################################################################################
527527
# @name: vstacklet::backup::retention (9)
528528
# @description: The retention used in the backup script. This is used to delete
529-
# old backups. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L544-L568)
529+
# old backups. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L544-L568)
530530
#
531531
# notes:
532532
# - The retention is based on the modification time of the file.
@@ -569,7 +569,7 @@ vstacklet::backup::retention() {
569569

570570
##################################################################################
571571
# @name: vstacklet::outro (10)
572-
# @description: Prints the outro message. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L575-L580)
572+
# @description: Prints the outro message. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L575-L580)
573573
# @break
574574
##################################################################################
575575
vstacklet::outro() {
@@ -581,7 +581,7 @@ vstacklet::outro() {
581581

582582
##################################################################################
583583
# @name: vstacklet::backup::usage
584-
# @description: Display the usage of the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L587-L640)
584+
# @description: Display the usage of the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L587-L640)
585585
# @break
586586
##################################################################################
587587
vstacklet::backup::usage() {
@@ -641,7 +641,7 @@ vstacklet::backup::usage() {
641641

642642
##################################################################################
643643
# @name: vstacklet::backup::example_cron
644-
# @description: Example cron job for the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L647-L655)
644+
# @description: Example cron job for the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L647-L655)
645645
# @break
646646
##################################################################################
647647
vstacklet::backup::example_cron() {
@@ -656,7 +656,7 @@ vstacklet::backup::example_cron() {
656656

657657
##################################################################################
658658
# @name: vstacklet::backup::version
659-
# @description: Display the version of the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vs-backup#L662-L668)
659+
# @description: Display the version of the backup script. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vs-backup#L662-L668)
660660
# @break
661661
##################################################################################
662662
vstacklet::backup::version() {

‎bin/backup/vstacklet-backup-standalone.sh‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
################################################################################
33
# <START METADATA>
44
# @file_name: vstacklet-backup-standalone.sh
5-
# @version: 3.1.1142
5+
# @version: 3.1.1143
66
# @description: This script will grab the latest version of vs-backup and
77
# install it on your server.
88
#
@@ -13,9 +13,9 @@
1313
# This script will backup your database and files.
1414
# Please ensure you have read the documentation before continuing.
1515
#
16-
# - [vStacklet Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/setup/vstacklet.sh.md)
17-
# - [vStacklet Server Stack Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/setup/vstacklet-server-stack.sh.md)
18-
# - [vStacklet VS-Backup Documentation](https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/backup/vs-backup.md)
16+
# - [vStacklet Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/setup/vstacklet.sh.md)
17+
# - [vStacklet Server Stack Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/setup/vstacklet-server-stack.sh.md)
18+
# - [vStacklet VS-Backup Documentation](https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/backup/vs-backup.md)
1919
#
2020
# This script will do the following:
2121
# - Download the latest version of vs-backup.
@@ -53,20 +53,20 @@
5353
# @description: This function will download the latest version of vs-backup
5454
# and install it on your server. It will also convert vs-backup shell scripts
5555
# to executable. From there, you can run vs-backup from anywhere on your server.
56-
# [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vstacklet-backup-standalone.sh#L60-L65)
56+
# [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vstacklet-backup-standalone.sh#L60-L65)
5757
#
5858
# @break
5959
################################################################################
6060
vstacklet::vsbackup::standalone() {
6161
# @script-note: download the latest version of vs-backup
62-
curl -s "https://raw.githubusercontent.com/JMSDOnline/vstacklet/development/bin/backup/vs-backup" >/usr/local/bin/vs-backup
62+
curl -s "https://raw.githubusercontent.com/JMSDOnline/vstacklet/main/bin/backup/vs-backup" >/usr/local/bin/vs-backup
6363
# @script-note: convert vs-backup shell scripts to executable
6464
chmod +x /usr/local/bin/vs-backup
6565
}
6666

6767
################################################################################
6868
# @name: vstacklet::vsbackup::outro
69-
# @description: This function will display the outro. [see function](https://github.com/JMSDOnline/vstacklet/blob/development/bin/backup/vstacklet-backup-standalone.sh#L73-L85)
69+
# @description: This function will display the outro. [see function](https://github.com/JMSDOnline/vstacklet/blob/main/bin/backup/vstacklet-backup-standalone.sh#L73-L85)
7070
#
7171
# @break
7272
################################################################################
@@ -77,7 +77,7 @@ vstacklet::vsbackup::outro() {
7777
echo "Please see the documentation for more information."
7878
echo ""
7979
echo "Documentation can be found here:"
80-
echo "https://github.com/JMSDOnline/vstacklet/blob/development/docs/bin/backup/vs-backup.md"
80+
echo "https://github.com/JMSDOnline/vstacklet/blob/main/docs/bin/backup/vs-backup.md"
8181
echo ""
8282
echo "You can also run the following command for more information:"
8383
echo "vs-backup -h"

0 commit comments

Comments
 (0)