## Allsky Software

The GitHub `allsky` repository consists of two main parts which are both included when installing Allsky.

1. Allsky is the main program that captures and saves images and includes the Web User Interface (WebUI) used to administer Allsky and parts of your Pi. You can also:
   - Display the most recent image, called a Liveview.
   - View all saved prior images, timelapses, keograms, and startrails.
   - Configure Allsky settings via the WebUI.
   - See the status of the LAN and WLAN (Wireless LAN).
   - Configure Wi-Fi.
   - View information about the Pi such as amount of free disk space, CPU temperature, etc.
   - Optionally view user-generated data such as ambient temperature or fan speed.
   - View Allsky Documentation, of which this page is part of.
2. Allsky Website is a simple web interface that can run on your Pi and/or a remote server and displays:
   - The most recent image.
   - An optional constellation overlay on the image.
   - Saved startrails, keograms, and/or timelapse videos.
   - Optionally the most recent "mini" timelapse video.
   - Information about your camera like location, owner, Pi version, camera type, etc.
   - Optional information about your settings.

The GitHub `user-modules` repository contains additional, user-developed modules that can be used with Allsky as explained on the Modules page.

## Terms

- The WebUI is the Web User Interface used to administer Allsky.
- When a page says "Allsky Software" or just "software" it's referring to the main Allsky software that's running on your Pi and resides in the ~/allsky directory.
- A server, as in "remote server", is a computer that often sits in a datacenter and has a dedicated purpose such as hosting web pages or returning search results like Google.
- The term Allsky Website is often shortened to Website - always with a capital W.
- A local Allsky Website runs on the same Pi that Allsky runs on.
  A remote Website runs somewhere else. Allsky doesn't care if the remote machine is a true "server" or simply a 10-year old PC sitting under your desk. The Allsky documentation considers both of them a "remote server".

## Documentation Conventions

- Commands that are to be executed on the Pi look like this: `systemctl start allsky`. When multiple commands are to be executed they are usually displayed like this and can typically be copied from the documenation and pasted into a Pi terminal window:

      systemctl start allsky
      date

- File and directory names are shown as: configuration.json.
- Links on the WebUI to its various pages are shown as: Editor.
- Settings in the WebUI appear as: Debug Level. Settings' values in the WebUI appear as: 3.