Skip to content

Latest commit

 

History

History
138 lines (84 loc) · 6.52 KB

vi-planet-configurations.md

File metadata and controls

138 lines (84 loc) · 6.52 KB

Planet Configurations (Step 3.2)

Estimated Time: 1.5h

Objectives

  • Learn about Planet and the difference between Nations and Communities
  • Create a local Planet Community
  • Register your Community and sync it with the Nation

Introduction

The Planet is not only a library, but also an individualized learning system, where students can select their own books and courses to target their individual goals. The two kinds of Planet apps are described below.

Planet Communities (Local)

  • Communities are how the Planet functions on a local network, with users connecting to a community using either a laptop or a Raspberry Pi and a router.
  • Periodically communities sync with Nations on the internet, which includes sending and receiving educational materials.
  • In the prior step, you created a Planet community on your computer. As you follow the steps on this page, you will access and configure your community.

Planet Nations (Internet)

  • Nations are Planet apps for the Internet, allowing communities to interact with each other.
  • Nations are connected to many communities and can run reports on any communities it owns.
  • As you complete these instructions, an OLE administrator will complete the registration of your community with the Virtual Intern Nation.

Database

  • Apache CouchDB is a database software that we use for the Planet. You can see the back-end interface of our CouchDB at http://localhost:2200/_utils. In _utils, you have the opportunity to see all data of your Planet application.

  • PouchDB is an open-source JavaScript database inspired by Apache CouchDB that is designed to run well within the browser. This allows applications to save data locally, so that users can enjoy all the features of an app even when they're offline. This database is also used in the planet.

Check if Planet is Running

Visit http://localhost:3300 or http://127.0.0.1:3300 to access the initial admin configuration page. If you cannot access it, follow the instructions below based on your OS.

  1. Run docker ps -a in your Linux/macOS terminal or Git Bash to check if your Community Planet is "up" and running.

  2. If it's not running, navigate to the planet directory on your local machine:

    • Linux: cd /srv/planet
    • macOS: cd ~/srv/planet
    • Windows: cd ~/srv/planet

  3. Run bash planet.sh start to start the service.

Configure Your Planet Community

Visit the initial admin configuration page by navigating to http://localhost:3300 or http://127.0.0.1:3300. Use planet as both the username and password, as specified in the Docker Compose YAML file from the previous step.

Become an Administrator

WARNING: Do not close this browser tab before completing the configuration, as you cannot return to this form. If you accidentally close the tab, run bash planet.sh down followed by bash planet.sh up to restart the process.

Fill out the configurations, ensuring your name matches your GitHub name for easy identification in Virtual Intern Nation. Select Virtual Intern Nation (vi) as the nation, as shown below. After completing the configurations, save a screenshot of the page to post on the Discord server after submitting your registration request.

Configurations

Next, provide the contact details of the community administrator.

Contact Details

Click the "Submit" button to send your registration request for approval. You will see the following message:

Community Accepted into the Nation

You can now log in with the admin credentials you created.

Finally, post the screenshot you took earlier to our Discord server's #vi-software channel.

Troubleshooting

  1. If you encounter any of the following issues, please follow the steps in the "Starting Over" section below:

    • no_db_found
    • Accidental deletion of your Planet admin account

  2. Planet Page Not Loading in Browser

    If the Planet page doesn't load in your browser, even with correct account configuration and approval:

    • First, try accessing the page in your browser's incognito/private mode to check if it's a cookie/cache issue.
    • If Planet loads in incognito/private mode, clear your browser cookies.
    • If it still doesn't load, follow the "Restarting the Containers" steps below.
    • If these steps don't work, follow the "Starting Over" section below to "rebuild" your Planet.

    Blank

  3. Account Not Recognized After Approval

    After your account is approved, the website might not recognize your registration, resulting in an infinite loading screen. Refreshing the page could leave it blank. To resolve this issue, follow the steps in the "Starting Over" section below.

    Not recognized

Restarting the Containers

To restart the containers, use

bash planet.sh restart

or

# Stop `planet` without removing it
bash planet.sh stop

# Start `planet` again
bash planet.sh start

Starting Over

Warning: This will perform a full uninstall, removing the entire community you configured, including the database.

# 1. Stop and remove containers, networks, volumes, and images
# created with the `planet.yml` configuration file
bash planet.sh down

# 2. Remove the planet folder you created in the previous step
# Linux
rm -rf /srv/planet

# macOS or Windows
rm -rf ~/srv/planet

# 3. Follow "YourOS - Run Planet Community with Docker" in the previous step (3.1) again

After planet is up and running, follow Configure Your Planet Community again, since your old community registration still exist on the nation side, please use a slightly different name for your configuration, e.g. <YourGitHubUserName>-1.

More Help

If you continue to have issues after troubleshooting with the above instructions, please reach out to us on Discord for assistance.

→ Next: Step 4.1 - Planet Tutorial

Return to First Steps