From 29fed4d45a084ed8ff1698044486580cb269990f Mon Sep 17 00:00:00 2001 From: Leopere Date: Thu, 11 Jul 2019 19:25:16 -0400 Subject: [PATCH] Removed more files There are too many locations where this app was poorly documented we're going to aim to have all documentation hosted on https://OhMyForm.com where it is hosted from GitHub Pages exclusively now with no coupling. --- INSTALLATION_INSTRUCTIONS.md | 125 -------------------------- tellform_installation_blog_post.mdown | 57 ------------ 2 files changed, 182 deletions(-) delete mode 100644 INSTALLATION_INSTRUCTIONS.md delete mode 100644 tellform_installation_blog_post.mdown diff --git a/INSTALLATION_INSTRUCTIONS.md b/INSTALLATION_INSTRUCTIONS.md deleted file mode 100644 index 1a871488..00000000 --- a/INSTALLATION_INSTRUCTIONS.md +++ /dev/null @@ -1,125 +0,0 @@ -TellForm Installation Instructions -================================== - - -## Table of Contents - -- [Local Deployment with Docker](#local-deployment-with-docker) -- [AWS AMI Deployment](#aws-ami-deployment) - - -## Local deployment with Docker - -Refer to [docker_files](https://github.com/tellform/docker_files). - -## AWS AMI Deployment - -### Prerequisites - -Instructions here are tested on an Amazon Linux AMI. First, set up your fresh new AMI by setting the environment variables: - -``` -$ sudo vim /etc/environment - -LANG=en_US.utf-8 -LC_ALL=en_US.utf-8 -``` - -Next, update and install build tools: -``` -$ sudo yum update -y -$ sudo yum groupinstall "Development Tools" -y -``` - -### Install docker - -``` -$ sudo yum install -y docker -$ sudo service docker start -``` - -To ensure docker can be run without `sudo` each time: -``` -$ sudo usermod -a -G docker ec2-user -$ logout -``` - -SSH back in, and test that `docker info` runs successfully. - -### Install docker-compose - -``` -$ sudo -i -$ curl -L https://github.com/docker/compose/releases/download/1.15.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose -$ sudo chmod +x /usr/local/bin/docker-compose -$ logout -``` - -### Clone our repo - -``` -$ git clone https://github.com/datagovsg/formsg.git -``` - -### Prepare .env file - -The `.env` file for remote deployment (or production) is slightly different from that of local deployment. -Create `.env` file at project root folder. Similarly, fill in `MAILER_SERVICE_PROVIDER`, `MAILER_EMAIL_ID`, `MAILER_PASSWORD` and `MAILER_FROM`. Note that now you have to fill in the public IP of your instance in `BASE_URL`. - -``` -APP_NAME=FormSG -APP_DESC= -APP_KEYWORDS= -NODE_ENV=production -BASE_URL= -PORT=4545 -DB_PORT_27017_TCP_ADDR= -REDIS_DB_PORT_6379_TCP_ADDR=formsg-redis -username=formsg_admin -MAILER_SERVICE_PROVIDER= -MAILER_EMAIL_ID= -MAILER_PASSWORD= -MAILER_FROM= -SIGNUP_DISABLED=false -SUBDOMAINS_DISABLED=true -DISABLE_CLUSTER_MODE=true -RAVEN_DSN= -PRERENDER_TOKEN= -COVERALLS_REPO_TOKEN= -``` - -### Install npm, bower and grunt - -``` -$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.32.0/install.sh | bash -$ . ~/.nvm/nvm.sh -$ nvm install 6.11.2 -$ npm install -g bower -$ npm install -g grunt-cli -$ npm install grunt -``` - -### Install dependencies - -``` -$ npm install --production -``` - -### Build docker image - -``` -$ docker-compose -f docker-compose-production.yml build -``` - -### Run docker containers - -``` -$ docker run -d -p 27017:27017 -v /data/db:/data/db --name formsg-mongo mongo -$ docker-compose -f docker-compose-production.yml up -``` - -Note that unlike dev, mongo container is run separately from compose. Hence `docker-compose down` does not take down the mongo container each time. Your application should run on the default port 80, so in your browser just go to your public IP. - -## Support - -Please contact David Baldwynn (team@tellform.com) for any details. \ No newline at end of file diff --git a/tellform_installation_blog_post.mdown b/tellform_installation_blog_post.mdown deleted file mode 100644 index f8b4389e..00000000 --- a/tellform_installation_blog_post.mdown +++ /dev/null @@ -1,57 +0,0 @@ -Introduction -=========== - -TellForm is a powerful, open-source form/survey tool that allows you to get data from your users quickly and easily while collecting powerful analytics to improve your surveys. TellForm offers a field by field analytics, custom subdomains per-user, an extendable API, logic-based field jumping, per-device visitor analytics and 11 types of form fields. - -By default, TellForm is setup to serve custom subdomains, but you can also configure it to work on a single domain, for those using it in more restricted environments. - -Exporters—both the official ones that the Prometheus team maintains as well as the community-contributed ones—provide information about everything from infrastructure, databases, and web servers to messaging systems, APIs, and more. - -In this tutorial, you'll install, configure, and secure TellForm to selfhost forms that will make it easy for you and your users to use. - -Prerequisites -Before following this tutorial make sure you have: - -One Ubuntu 16.x or 14.x Droplet, set up by following the [Initial Server Setup with Ubuntu 16.04 tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-16-04), including a sudo non-root user and a firewall. -Nginx installed by following the first two steps of the [How To Install Nginx on Ubuntu 16.04 tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-16-04). -Docker installed by following the steps of the [How To Install and Use Docker on Ubuntu 16.04 tutorial](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04) - - -## Step 1 - Fetch Docker-Compose Files - -``` -$ curl -L github.com/tellform/tellform/stable/blob/docker-compose.yml -$ curl -L github.com/tellform/tellform/stable/blob/.env -``` - -### Prepare .env file: -Create `.env` file at project root folder. Fill in `MAILER_SERVICE_PROVIDER`, `MAILER_EMAIL_ID`, `MAILER_PASSWORD` and `MAILER_FROM`. -``` -APP_NAME=TellForm -BASE_URL=localhost:3000 -PORT=3000 -DB_PORT_27017_TCP_ADDR=tellform-mongo -REDIS_DB_PORT_6379_TCP_ADDR=tellform-redis -MAILER_SERVICE_PROVIDER= -MAILER_EMAIL_ID= -MAILER_PASSWORD= -MAILER_FROM= -SIGNUP_DISABLED=false -SUBDOMAINS_DISABLED=true -DISABLE_CLUSTER_MODE=true -``` - -### Build docker image - -``` -$ docker-compose build -``` - -### Run docker containers with docker-compose - -Create and start mongo & redis docker container: -``` -$ docker-compose up -d -``` - -Your application should run at the BASE_URL you specified on port 443. \ No newline at end of file