Merge pull request #1 from BitCurator/MERGE/ds

Merge/ds

Author: kamwoods

.ci/tag-version

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+TAG=${1}
+VALID_TAG=false
+
+if [ "x${TAG}" == "x" ]; then
+  echo "You must specify a tag"
+  exit 10
+fi
+
+if [ ! -f "package.json" ]; then
+  echo "This script should be run from the root of the directory"
+  exit 11
+fi
+
+BRANCH=$(git symbolic-ref HEAD 2> /dev/null)
+BRANCH=${BRANCH##refs/heads/}
+
+if [ "${BRANCH}" != "main" ]; then
+  echo "You must only be on the main branch"
+  exit 12
+fi
+
+if [ $(echo ${TAG} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+$") ]; then
+  VALID_TAG=true
+fi
+
+if [ $(echo ${TAG} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$") ]; then
+  VALID_TAG=true
+fi
+
+if [ $(echo ${TAG} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+-rc[0-9]+$") ]; then
+  VALID_TAG=true
+fi
+
+if [ "${VALID_TAG}" == "false" ]; then
+  echo "The tag specified was invalid."
+  exit 10
+fi
+
+VTAG="v${TAG}"
+MSG="version ${TAG}"
+
+npm --no-git-tag-version version $TAG
+
+git commit -a -m "${MSG}"
+git tag -m "${MSG}" ${VTAG}
+git push origin master
+git push origin --tags

.ci/version

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+set -x
+
+version=$(jq -r '.version' package.json || echo dev | sed -e 's/^v//g')
+exact_tag=$(git describe --exact-match 2>/dev/null | sed -e 's/^v//g' || echo "")
+
+last_tag=$(git describe --tags --abbrev=0)
+commits=$(git log --oneline ${last_tag}..HEAD | wc -l | tr -d '[:space:]')
+revision=$(git rev-parse --short HEAD || echo unknown)
+
+if [ $(echo ${exact_tag} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+$") ]; then
+    echo $exact_tag
+    exit 0
+fi
+
+if [ $(echo ${exact_tag} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+-rc\.[0-9]+$") ]; then
+    echo $exact_tag
+    exit 0
+fi
+
+if [ $(echo ${exact_tag} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+-rc[0-9]+$") ]; then
+    echo $exact_tag
+    exit 0
+fi
+
+echo "${version}.${commits}.g${revision}"

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+release
+config.json
+.*rc
+extras
+

BUILD.md

@@ -0,0 +1,64 @@
+## Building the CLI
+### Pre-requisites
+- jo
+- jq
+- gpg
+- git
+- nodejs (v12 - 14, with npm - see instructions [here](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions))
+
+```bash
+$ sudo apt-get install jo jq gpg nodejs
+```
+### Modifying
+To customize the CLI, it's important to change the following spots in the CLI (as desired):
+#### xxx-cli.js
+- lines 35-50 (usage)
+- lines 56-85 (PGP public key)
+- `const help` (line 88)
+- `const listReleases` (line 263 - important for pointing to the correct repo)
+- `const downloadReleaseFile` (line 321, variable `req`)
+- `const downloadRelease` (line 350, variable `req`)
+- and anywhere else that might need to be customized for your release.
+
+#### package.json
+Important areas to modify:
+- `name`
+- `version`
+- `scripts for pkg:prep/build/hash/sign` (important for signing release)
+- `repository: url` (line 40)
+
+#### package-lock.json
+Important areas to modify:
+- `name`
+- `version`
+
+### Building
+Change to the CLI directory and run the following:
+```bash
+$ sudo npm install -g pkg docopt @octokit/rest js-yaml mkdirp openpgp request semver split username bluebird
+$ npm install bluebird
+$ npm install
+```
+To avoid having the node_modules folder, and the soon-to-be-created release folder, uploaded during a `git push`, create a `.gitignore` file and ensure these are added.
+
+Now, update the version number in the `package-lock.json` file and the `package.json` file.
+
+While still in the directory, run: `npm run pkg`
+
+This will create the release folder with a `.sha256.asc` signature and the generated binary. Once your build is tested and you're satisfied with the way it turned out, it's time to release it.
+
+### Release
+First thing to do would be to add, commit, and push to the repo:
+```bash
+$ git add -A
+$ git commit -m ''
+$ git push origin
+```
+Once your push is complete, generate a tag:
+`$ git tag vX.Y.Z` where `X.Y.Z` is your Major/Minor/Patch version number.
+
+Push the tagged release:
+`$ git push origin vX.Y.Z`
+
+Go to the Tags section on GitHub, select your tag, and click `Create Release from Tag`
+Name this release with the same version number as the tag, then browse to your release folder and upload both files (the binary, and the .sha256.asc file).

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 BitCurator
+Copyright (c) 2022 Digital Sleuth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,110 @@
-# bitcurator-cli
+![Logo](https://github.com/BitCurator/bitcurator.github.io/blob/main/logos/BitCurator-Basic-400px.png)
+
+# bitcurator-cli
+
+[![GitHub issues](https://img.shields.io/github/issues/bitcurator/bitcurator-salt.svg)](https://github.com/bitcurator/bitcurator-salt/issues)
+[![GitHub forks](https://img.shields.io/github/forks/bitcurator/bitcurator-salt.svg)](https://github.com/bitcurator/bitcurator-salt/network)
+[![Twitter Follow](https://img.shields.io/twitter/follow/bitcurator.svg?style=social&label=Follow)](https://twitter.com/bitcurator)
+
+BitCurator CLI Installer
+
+This repo contains the source for the BitCurator CLI installer, a command line tool to install and upgrade the BitCurator environment.
+
+You can find pre-built virtual machines (Ubuntu 22.04-based) at https://github.com/BitCurator/bitcurator-distro/wiki/Releases for specific releases. If you wish to create the environment from scratch, you can follow the steps below to install the BitCurator environment on your own physical host or VM.
+
+**Note: BitCurator must be deployed on an x86/amd64 version of Ubuntu. Currently, it is not possible to deploy it on systems with ARM processors (including Apple M1).**
+
+**1. Install Ubuntu 22.04**
+
+Download the 64-bit Ubuntu 22.04 desktop image from https://releases.ubuntu.com/22.04/ubuntu-22.04-desktop-amd64.iso and install on your local machine or in a VM. If you're using a VM, we recommend allocating at least 4GB of RAM and 64GB of disk space to the instance.
+
+To remain consistent with the default configuration of BitCurator, when prompted use **BitCurator** for the Full Name, **bcadmin** for the username, and **bcadmin** for the password.
+
+When installation is completed, reboot, log in, and open a terminal.
+
+**2. Download the BitCurator CLI Installer**
+
+Download the BitCurator installer from iBiblio with the following command:
+
+```shell
+wget https://distro.ibiblio.org/bitcurator/bitcurator-cli-linux
+```
+
+Verify that the SHA-256 has of the downloaded file matches the value below:
+
+```shell
+377065fd9880e511c3c5db7306c5b40dd507ba491a89452cf05f2b570946c5c0
+```
+
+You can generate the hash of your downloaded file with:
+
+```shell
+sha256sum bitcurator-cli-linux
+```
+
+Finally, perform a few setup steps to make the installer executable and place it in the correct location:
+
+```shell
+mv bitcurator-cli-linux bitcurator
+chmod +x bitcurator
+sudo mv bitcurator /usr/local/bin
+```
+
+**3. Install GnuPG**
+GnuPG is required for BitCurator to automatically validate the configuration files required during installation. Install it using:
+
+```
+sudo apt install -y gnupg
+```
+
+**4. Run the BitCurator Installer**
+
+```
+sudo bitcurator install
+```
+
+The installation may take up to an hour, depending on the speed of your system.
+
+If you encounter an error, you may be able to identify the issue by reviewing saltstack.log file under /var/cache/bitcurator/cli in the subdirectory that matches the BitCcurator state-files version you're installing. Search for the log file for result: false messages and look at the surrounding 5 lines or the 8 lines above each message to see the state file that caused the issue. You can do this with:
+
+```shell
+grep -i -C 5 'result: false' or grep -i -B 8 'result: false'
+```
+
+**5. Reboot**
+
+When the installation is complete, reboot your system from the terminal:
+
+```shell
+sudo reboot
+```
+
+After the reboot, you will be automatically logged in to BitCurator.
+
+## BitCurator documentation, help, and other information
+
+User documentation and additional resources are available on
+[the BitCurator Environment wiki](https://confluence.educopia.org/display/BC).
+
+Questions and comments can also be directed to the bitcurator-users list.
+
+[https://groups.google.com/d/forum/bitcurator-users](https://groups.google.com/d/forum/bitcurator-users)
+
+## Acknowledgements
+
+This tool originally authored by Erik Kristensen, and revised for BitCurator by Corey Forman.
+
+## License(s)
+
+See LICENSE file for details. 
+
+The BitCurator logo, BitCurator project documentation, and other non-software products of the BitCurator team are subject to the the Creative Commons Attribution 4.0 Generic license (CC By 4.0).
+
+## Development Team and Support
+
+The BitCurator environment is a product of the BitCurator team housed at the School of Information and Library Science at the University of North Carolina at Chapel Hill. Funding between 2011 and 2014 was provided by the Andrew W. Mellon Foundation.
+
+Ongoing support for the BitCurator environment is managed by the BitCurator Consortium. Find out more at:
+
+http://www.bitcuratorconsortium.net/
+