Install Nurtch Trial

Nurtch is a self hosted software and there are 2-ways to install it.

Docker Container Image
Amazon Machine Image
Install via Docker Container ImageInstall via Amazon Machine Image (AMI)

Install via Docker Container Image

Nurtch trial image is available at docker hub. Latest image can be pulled with,

docker pull nurtch/nurtch

You can use Kubernetes, ECS or any deployment tool of your choice to setup Nurtch with this image.

Following environment variables are required to be set on the container:

Instructions for creating S3 bucket and IAM user.

{  "Version":"2012-10-17", 
  "Statement": [ {
            "Sid":"VisualEditor0", 
           "Effect":"Allow",      
            "Action":"s3:ListAllMyBuckets",  
            "Resource":"*"
        },
        {  
           "Sid":"VisualEditor1",
            "Effect":"Allow",
            "Action":"s3:*",
            "Resource":[
                "arn:aws:s3:::<your_bucket_name></your_bucket_name>/*",
                "arn:aws:s3:::<your_bucket_name></your_bucket_name>"
            ]
        }
    ]
}

If you have any questions click on the chat box at the right bottom corner or write to us at team@nurtch.com.

Install via Amazon Machine Image (AMI)

We've made an Amazon Machine Image (AMI) so you can quickly deploy on AWS EC2.

Prerequisite
Installation Overview

Step 1: Spin up EC2 machine

Launch an EC2 instance using the link below.

Select appropriate instance size. In most cases t2.micro should work fine for trial purpose. Choose default option for all other configuration & launch an EC2 instance.

Step 2: Configure Security Group

We need to open port 80 for incoming HTTP traffic to Nurtch server. Select your EC2 instance on AWS console and click on the Security Group under Description tag. Inside Security Group settings, edit the inbound rules and allow HTTP traffic to port 80 as shown below.

Step 3: Test your installation

At this point you should be able to access the Nurtch server in your browser. From EC2 management console copy the public IP address of your instance. Hit it in the browser and you should see the Nurtch login page. If you see nginx error wait for couple of minutes for Nurtch to startup fully on the ec2 machine.

You can use our default credentials (admin/qf@123) to log into Nurtch. You might see some existing notebooks after you login. Note that, currently your installation is using one of our S3 buckets for storing notebooks. Let's change that to use your own S3 bucket in the next step.

Step 4: Create S3 bucket and IAM user

{
    "Version":"2012-10-17",
    "Statement":[
        {
            "Sid":"VisualEditor0",
            "Effect":"Allow",
            "Action":"s3:ListAllMyBuckets",
            "Resource":"*"
        },
        {
            "Sid":"VisualEditor1",
            "Effect":"Allow",
            "Action":"s3:*",
            "Resource":[
                "arn:aws:s3:::<your_bucket_name>/*",</your_bucket_name>
                "arn:aws:s3:::<your_bucket_name>"</your_bucket_name>
            ]
        }
    ]
}

Step 5: Configure

Let's update the configuration to use your own S3 bucket.

ssh -i ~/.ssh/<your-ssh-key>.pem ec2-user@<ip-address-of-instance></ip-address-of-instance></your-ssh-key>
nano ~/.jupyter/nbconfig/cwiki.json
supervisorctl restart all

Step 6: Validate

Put the EC2 instance's IP address in the browser again and make sure the login page comes up. Now logging in with your new credentials should succeed. Create new notebooks, publish them to S3 and everything should work seamlessly.

If you see any errors about communicating with S3, make sure that IAM user has all the required credentials as mentioned in Step 4.

Step7: [Optional] Add a CNAME

Using IP address to access anything is not fun. Create a CNAME entry with your DNS provider for easy access to Nurtch trial.

If you have any questions click on the chat box at the right bottom corner or write to us at team@nurtch.com.