gitpod.md

Running the FarmData2 Development Environment in GitPod

When a FarmData2 Development Environment is run in GitPod you will use your browser to connect to the Linux-based desktop with your browser.

Install Help

If you run into problems during the install visit the dedicated install stream on the FarmData2 Zulip chat. Use the search feature to see of others have had and solved the problem you are experiencing. If you do not find a solution, post a summary of your problem and the community will help.

Creating a FarmData2 Development Environment Workspace

Use the following steps to create a FarmData2 Development Environment in a GitPod workspace:

1. Sign up for a free GitPod account.
   • Use your GitHub credentials to log in.
     • The free account provides 50 hours/week of usage. More hours can be purchased at a reasonable rate.
2. Visit the GitPod Preferences page.
   1. Under "New Workspaces," set the "default editor" to be "Terminal,"
   2. Under "Timeouts," set the "Default Workspace Timeout" to be 10m.
      • This will automatically shut down your workspace after 10 minutes of inactivity and will prevent you from wasting your free hours.
3. Fork the upstream FarmData2 repository in GitHub.
4. Copy the URL of your fork. This URL should have your GitHub username in it.
5. Visit the new GitPod workspace page and paste the URL of your FarmData2 fork into the "Select a repository" search box and click the search result.
6. Click "Continue."
7. After about 2-5 minutes a terminal window will open in your browser. This document will call this terminal the GitPod Terminal.
   1. The GitPod Terminal will display information about starting the FarmData2 Development Environment, including about "Starting containers."
   2. After another 2-3 minutes the containers will have started and the GitPod Terminal will display information about how to connect to the FarmData2 Development Environment. You can connect to the FarmData2 Development Environment in two ways:
      • Connect by using your web browser by clicking the https link given in the output and then clicking the "Connect" button on the page that appears. See the Connect Using Your Web Browser section for more information.
      • To connect by using a VNC client:
        • Visit Gitpod's guide to create a SSH key and follow the instructions to create and upload a SSH key to Gitpod. This step only needs to be completed once.
        • Then, follow the instructions in the GitPod Terminal output. See the Connect Using a VNC Client section for more information.
8. Follow the directions to Setup the FarmData2 Development Environment
9. Visit your GitPod workspaces
   • Your "farmdata2" workspace will appear here with a green dot to its left, indicating that the workspace is running.
10. Click the three vertical dots to the right of your farmdata2 workspace.
11. Select "Pin" - this will keep your workspace from being deleted if inactive for two weeks.
12. Click the three vertical dots again.
13. Select "Stop" - this will shutdown your workspace and close the FarmData2 Development Environment as well.

Restarting a FarmData2 Development Environment Workspace

The FarmData2 Development Environment will restart much faster after you have created the GitPod workspace.

To restart the Development Environment:

1. Visit your GitPod workspaces.
2. Click the three vertical dots to the right of your "farmdata2" workspace."
3. Select "Open"
4. Follow the instructions to connect to the FarmData2 Development Environment in your browser or by using a VNC client.
5. When you are done working:
   1. Push the branch you are working on to your GitHub as a backup.
   2. Stop the your farmdata2 workspace by using one of the following methods:
      • Visit your GitPod workspaces, click the three vertical dots to the right of your farmdata2 workspace and select "stop."
      • Type gp stop in the GitPod Terminal.