Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
jstack-awesomekb/deploy.sh
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
executable file
309 lines (210 sloc)
11 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| #!/bin/bash | |
| # Run this script from within jstack-awesomekb root folder | |
| install_prerequisites() { | |
| # Assumed: git clone https://darkquasar@github.com/darkquasar/jstack-awesomekb | |
| sudo apt-get update \ | |
| && sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - \ | |
| && sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" \ | |
| && sudo apt-get update \ | |
| && sudo apt-get install -y docker-ce apache2-utils keychain \ | |
| && sudo service docker start \ | |
| && sudo curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose \ | |
| && sudo chmod +x /usr/local/bin/docker-compose \ | |
| && sudo usermod -aG docker ${USER} \ | |
| && echo "Let's create a simple user so that we can access MailCatcher later in the demo environment" \ | |
| && sudo htpasswd -bcB docker/compose/nginx/portal/.htpasswd jaguarlord MyAwesomePassword | |
| } | |
| generate_documentation() { | |
| if [ ! $# = 1 ]; then | |
| echo "[J-Stack-AwesomeKB] Please provide a name for the virtual server you are trying to generate the output to (ex. awesomekb.jstack.com)" | |
| exit 1 | |
| fi | |
| # 1. Generate the documentation | |
| # This docker command will pull darkquasar/inca-sphinx:1.0.0 from DockerHub and build your documentation | |
| # Any errors or warnings will be written to ./docker/compose/nginx/backend/html/awesomekb/warnings.log | |
| echo "[J-Stack-AwesomeKB] Generating Documentation" | |
| docker run -v $(pwd)/docs:/docs/source -v $(pwd)/docker/compose/nginx/backend/html/$1:/docs/build darkquasar/inca-sphinx:1.1.0 sphinx-build -b html source build -w build/warnings.log | |
| # 2. Check whether documentation was properly generated | |
| if [ ! -f docker/compose/nginx/backend/html/$1/index.html ]; then | |
| echo "Documentation not generated! Check $(pwd)/docker/compose/nginx/backend/html/awesomekb/warnings.log Alternatively, run inca-sphinx in interactive mode and build your documentation that way. Be sure to map a volume to \"$(pwd)/docker/compose/nginx/backend/html/awesomekb\" which is where jstack-nginx-backend will search for the documents to be served by nginx. Exiting..." | |
| exit 1 | |
| fi | |
| } | |
| generate_sphinx_pdf() { | |
| # This function will generate the PDF equivalent of the .RST files using LaTeX and Sphinx. | |
| if [ $# = 0 ]; then | |
| echo "[J-Stack-AwesomeKB] Please provide a name for the virtual server you are trying to generate the output to (ex. awesomekb.jstack.com)" | |
| exit 1 | |
| fi | |
| if [ ! $# = 2 ]; then | |
| echo "[J-Stack-AwesomeKB] Please provide a name for the LaTeX file that should be used as base for the PDF generation (ex. MyKB.tex)" | |
| exit 1 | |
| fi | |
| # 1. Generate the documentation | |
| # This docker command will pull darkquasar/inca-sphinx:1.0.0 from DockerHub and build your documentation | |
| echo "[J-Stack-AwesomeKB] Generating PDF Documentation" | |
| docker run -v $(pwd)/docs:/docs/source -v $(pwd)/docker/compose/nginx/backend/html/$1:/docs/build darkquasar/inca-sphinx:1.1.0 bash -c "mkdir latexbuild; sphinx-build -b latex source latexbuild; cd /docs/latexbuild; pdflatex $2; cp *.pdf /docs/build; exit" | |
| # 2. Check whether documentation was properly generated | |
| if [ ! -f docker/compose/nginx/backend/html/$1/$2 ]; then | |
| echo "Documentation not generated! Check $(pwd)/docker/compose/nginx/backend/html/awesomekb/warnings.log Alternatively, run inca-sphinx in interactive mode and build your documentation that way. Be sure to map a volume to \"$(pwd)/docker/compose/nginx/backend/html/awesomekb\" which is where jstack-nginx-backend will search for the documents to be served by nginx. Exiting..." | |
| exit 1 | |
| fi | |
| } | |
| run_kb() { | |
| # Note: Pass in the name of the backend virtual server | |
| # to this function, ex. "awesomekb.jstack.com" | |
| generate_documentation $1 | |
| # 3. Run the KB stack | |
| cd docker && docker-compose up --build -d | |
| } | |
| replace_domain() { | |
| # This function will look into the nginx folder and replace any files | |
| # containing the default "jstack.com" domain with the domain of your choosing. | |
| # Useful when you want to test jstack-awesomekb with your own domain or an | |
| # AWS default one for example. | |
| # Determining whether the script is being sourced or run in new shell | |
| # in order to assign $SCRIPTPATH | |
| if [ ! $0 = $BASH_SOURCE ]; then | |
| SCRIPTPATH="$( cd "$(dirname "$BASH_SOURCE")" ; pwd -P )" | |
| else | |
| SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )" | |
| fi | |
| find $SCRIPTPATH/docker/compose/nginx -type f -print0 | xargs -0 sed -i "s/jstack.com/$1/g" | |
| find $SCRIPTPATH/docker/compose/authelia -type f -print0 | xargs -0 sed -i "s/jstack.com/$1/g" | |
| sed -i "s/awesomekb.jstack.com/awesomekb.$1/g" $SCRIPTPATH/docker/docker-compose.yml | |
| sed -i "s/compose\/nginx\/backend\/html\/awesomekb/compose\/nginx\/backend\/html\/awesomekb.$1/g" $SCRIPTPATH/docker/docker-compose.yml | |
| } | |
| generate_certs() { | |
| # Determining whether the script is being sourced or run in new shell | |
| # in order to assign $SCRIPTPATH | |
| if [ ! $0 = $BASH_SOURCE ]; then | |
| SCRIPTPATH="$( cd "$(dirname "$BASH_SOURCE")" ; pwd -P )" | |
| else | |
| SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )" | |
| fi | |
| portal_serv_certpath=$SCRIPTPATH/docker/compose/nginx/portal/ssl | |
| # generate the private key | |
| openssl genrsa -out $portal_serv_certpath/server.key 4096 | |
| # generate the certificate signing request | |
| openssl req -new -key $portal_serv_certpath/server.key -out $portal_serv_certpath/server.csr -subj "/C=AR/ST=Salta/L=Salta/O=J-Stack/CN=JS" | |
| # finally generate the certificate itself | |
| openssl x509 -req -sha256 -days 999 -in $portal_serv_certpath/server.csr -signkey $portal_serv_certpath/server.key -out $portal_serv_certpath/server.crt | |
| } | |
| deploy_all() { | |
| # NOTE: This function will expect a value for the backend virtual | |
| # server that you want to run. Ideally it should match the name of | |
| # your site, ex. "awesomekb.jstack.com" | |
| # Colours | |
| RED='\033[0;31m' | |
| NC='\033[0m' # No Color | |
| GREEN='\033[0;32m' | |
| PURPLE='\033[0;35m' | |
| # Let's grab the public DNS name of the EC2 instance | |
| printf '\n'${GREEN}'[J-Stack-AwesomeKB]'${NC}' Grabbing your AWS public DNS\n' | |
| publicdns=$(curl -s http://169.254.169.254/latest/meta-data/public-hostname) | |
| publicipv4=$(curl http://169.254.169.254/latest/meta-data/public-ipv4) | |
| printf '\n'${GREEN}'[J-Stack-AwesomeKB]'${NC}' Installing pre-requisites\n' | |
| install_prerequisites | |
| printf '\n'${GREEN}'[J-Stack-AwesomeKB]'${NC}' Fixing environment so that $publicdns becomes your domain name\n' | |
| replace_domain $publicdns | |
| printf '\n'${GREEN}'[J-Stack-AwesomeKB]'${NC}' Launching AwesomeKB stack with docker-compose\n' | |
| run_kb awesomekb.$publicdns | |
| printf '\n'${GREEN}'[J-Stack-AwesomeKB]'${NC}' Done!, Now please reboot this instance so that we can apply some changes. Then in the host you are using to access the site from (were you launch your browser from) add these to your hosts file:\n\n'${GREEN}'%b '${PURPLE}'login.%b \n'${GREEN}'%b '${PURPLE}'ldapadmin.%b \n'${GREEN}'%b '${PURPLE}'mailcatcher.%b \n'${GREEN}'%b '${PURPLE}'awesomekb.%b\n\n'${NC}'' $publicipv4 $publicdns $publicipv4 $publicdns $publicipv4 $publicdns $publicipv4 $publicdns | |
| } | |
| git_pull_cron() { | |
| # This func requires that you have an SSH key already setup | |
| # for secure GitHub connection. It looks for documentation | |
| # source .rst or .md files inside the repos "docs" folder. | |
| # If you call this function from within a cron job, make sure | |
| # you do it as the right user. | |
| # Dependencies: keychain needs to be installed to automate this process | |
| # Add "eval `keychain --eval id_rsa`" to your .bashrc | |
| # Run in background with: nohup ./deploy.sh git-pull &>/dev/null & | |
| # Add to Cron with "crontab -e" and run every minute with "* * * * * /home/[user]/[repo_folder]/deploy.sh git-pull-cron darkquasar/jstack-awesomekb awesomekb.jstack.com" | |
| # Changing directory to script one so that we can | |
| # run "git pull" inside it. | |
| # This should be the root dir of the repo containing | |
| # the ./docker and ./docs folders | |
| if [ ! $# = 2 ]; then | |
| printf "\n[J-Stack-AwesomeKB] Not enough arguments, please provide [name of repo to clone] and [name of html backend virtual server]\n" | |
| exit 1 | |
| fi | |
| # Determining whether the script is being sourced or run in new shell | |
| # in order to assign $SCRIPTPATH | |
| if [ ! $0 = $BASH_SOURCE ]; then | |
| SCRIPTPATH="$( cd "$(dirname "$BASH_SOURCE")" ; pwd -P )" | |
| else | |
| SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )" | |
| fi | |
| cd $SCRIPTPATH | |
| eval `keychain --noask --eval id_rsa` | |
| repo=git@github.com:$1 | |
| repo_name=$(echo $repo | grep -Pio "(?<=\/).*") | |
| target_folder=$SCRIPTPATH/docs-$repo_name | |
| # If the target_folder doesn't exist, let's | |
| # (1) clone the repo for the first time | |
| # (2) build the documentation for the first time | |
| if [ ! -d "$target_folder" ]; then | |
| # Cloning the repo | |
| printf "\n[J-Stack-AwesomeKB] Cloning Repository "$2" for the first time\n" | |
| git clone $repo $target_folder | |
| # $2 name of the html virtual server in backend | |
| rm -rf $SCRIPTPATH/docker/compose/nginx/backend/html/$2 | |
| rm -rf $SCRIPTPATH/docs/* | |
| # Copying the updated contents into our current /docs folder | |
| cp -r $target_folder/docs/* docs | |
| # Generating documentation | |
| printf "\n[J-Stack-AwesomeKB] Generating Documentation for the first time into "$2"\n" | |
| generate_documentation $2 | |
| # Else, repo with documentation has been already cloned | |
| # only an update needed (git pull) | |
| else | |
| # Update tmp repo | |
| printf "\n[J-Stack-AwesomeKB] Updating Docs Repo with Git Pull\n" | |
| cd $target_folder | |
| git stash save --keep-index | |
| gp=$(git pull | grep -io "up to date") | |
| if [ ! "$gp" = "up to date" ]; then | |
| printf "\n[J-Stack-AwesomeKB] Documentation Not Up to Date. Updating...\n" | |
| # Copying the updated contents into our current /docs folder | |
| rm -rf $SCRIPTPATH/docs/* | |
| cp -r $target_folder/docs/* $SCRIPTPATH/docs | |
| cd $SCRIPTPATH # need to go up one level since we are inside $target_folder | |
| printf "\n[J-Stack-AwesomeKB] Generating Documentation into "$2"\n" | |
| generate_documentation $2 | |
| else | |
| printf "\n[J-Stack-AwesomeKB] Documentation Up to Date. No changes needed...\n" | |
| fi | |
| fi | |
| } | |
| generate_sshkeys() { | |
| ssh-keygen -t rsa -b 4096 -C "admin@jstack.com" | |
| } | |
| removecontainers() { | |
| # Simple function to stop all containers | |
| docker stop $(docker ps -aq) | |
| docker rm $(docker ps -aq) | |
| } | |
| if [ $1 = "install-prerequisites" ]; then | |
| install_prerequisites | |
| elif [ $1 = "run" ]; then | |
| run_kb $2 | |
| elif [ $1 = "replace-domain" ]; then | |
| if [ -z $2 ]; then | |
| echo "Please provide a domain to replace the default \"jstack.com\" with" | |
| exit 1 | |
| fi | |
| replace_domain $2 | |
| elif [ $1 = "deploy-all" ]; then | |
| deploy_all | |
| elif [ $1 = "generate-sshkeys" ]; then | |
| generate_sshkeys | |
| elif [ $1 = "git-pull-cron" ]; then | |
| git_pull_cron $2 $3 | |
| elif [ $1 = "removecontainers" ]; then | |
| removecontainers | |
| elif [ $1 = "gen-certs" ]; then | |
| generate_certs | |
| elif [ $1 = "gen-sphinx-pdf" ]; then | |
| generate_sphinx_pdf $2 $3 | |
| fi |