Home

Note: You must fork this repository in order to make changes! Once you fork this repo, a development environment will automatically be provisioned for you. The provisioning process takes 5-10 minutes; if you are unable to login after this time window, please contact [email protected] for assistance.

In this exercise, you will be connecting to a server hosting a development environment for you. This guide will walk through how to connect to this server to make changes, view the changes in your browser, and provide instructions for configuring your FTP client if needed.

If you would prefer to set up and use your own development environment, you can see the project requirements and installation steps.

Your environment

<GHUser> should be replaced in any commands or URIs with your Github username.

Hostname: <GHUser>.test-sandbox.baseplatform.io
Username: <GHUser>
Password: <GHUser>

Connecting

You will need to connect to your environment using SSH. If you are Windows and do not have an SSH client, download Putty.

1. Connect via SSH

Open your Terminal and execute the following command to connect to your instance. When prompted, your password is the same as your username.

ssh <GHUser>@test-sandbox.baseplatform.io

You now have a connection open to your environment -- you will use this later when committing your changes. For now, you will need to generate an SSH key and add it to your Github account to allow your changes to be saved to your fork.

2. Git configuration

In order to track your git changes to your Github account, you need to configure git within your environment. To do so, execute the following commands:

git config --global user.email "<[email protected]>"
git config --global user.name "<Your Name>"

Please delete your fork now. To ensure a consistent testing experience for all users, no changes should be pushed to your fork -- your changes will be reviewed within the development environment. You can delete your fork by visiting your fork's settings https://github.com/<GHUser>/fleet-command/settings and selecting the delete option.

3. Generate an SSH key

In the SSH prompt, execute ssh-keygen -t rsa -b 4096 to generate a new SSH key. Press the Enter key to use the default settings in each of the following prompts.

4. Copy your SSH public key

After you have generated your key, type cat ~/.ssh/id_rsa.pub to display your public key. Copy the following line of text (Starts with ssh-rsa and ends with <GHUser>@test-sandbox.baseplatform.io).

5. Add your new key to Github

Next, go to SSH Keys under your Github account settings. Click on Add SSH Key and paste your new public key into the Key field. Then select Add Key at the bottom.

Making changes

Your working directory for this project is located in the htdocs folder.

If you are comfortable using server-side tools such as vim or nano, you can use them to modify files in your workspace via SSH.

If you prefer a local text editor or IDE, you can use these configuration instructions to configure an FTP client to access your files. Your FTP client must be capable of SFTP (FTP over SSH), or use the recommended clients.

Previewing changes

You can view your instance of the application by visiting the Hostname above in your browser.

Committing changes

To commit a change, use the command-line git application.

• To see what files are changed, execute git status.
• To see what is changed, execute git diff[ filename].
• To add a file to be committed, execute git add <filename>.
• To commit your changes, execute git commit -m '<message>'.