Skip to content

Additional Configuration

Adam Schwalm edited this page Nov 8, 2018 · 8 revisions

The pISO supports some additional configuration via the 'piso.config' file on the SD card. This page documents the various options and their meanings.

piso.config

The config file is located on the SD card, in the same directory as the rootfs.squashfs. It is a simple TOML file. However, the user does not need to be familiar with TOML to edit the config file, as it is very simple.

For example, here is a sample config file:

[ui]
size_step=5
default_size=50
min_button_press=50
button_long_press=1400
sort_drives=true

[user]
name="piso"
password="password"

[[drive]]
name="Drive1"
newname="Linux Drive"

[[wifi.client]]
ssid="home-ap"
password="someexamplepassword"

[[wifi.client]]
ssid="test"
password="adifferentpassword"

[wifi.ap]
ssid="piso"
password="piso"

Notice that the file is divided in to sections with various options. For example, the UI section contains options that relate to the interface displayed on the LCD screen. The documentation for the meaning of each section and the options in them can be found below:

ui

As mentioned, ui contains options related to the user interface on the LCD. It has the following options:

  • size_step: When selecting the size for a new drive, this is the percentage to increase or decrease the size by per button press.
  • default_size: When selecting the size for a new drive, this is the starting percentage
  • min_button_press: The minimum time (in milliseconds) a button must be pressed to register a 'press'.
  • button_long_press: The minimum time (in milliseconds) a button must be held to be considered a 'long press'.
  • sort_drives: If set to 'true' (e.g. "sort_drives=true"), virtual drivers are shorted by their names

system

This section contains configuration for various system-wide parameters.

  • auto_fstrim: When set to 'true' (e.g., adding a line auto_fstrim=true), the pISO will perform an fstrim operation on drives at startup. This can improve the accuracy of the '% Free' displayed on the side of the screen, but may slow down startup.

user

This section contains information about the 'user' of the pISO. This will typically be used when logging in to a service on the pISO. For example, the FTP and SAMBA servers require the user to authenticate with the username and password in this section.

  • name: The user's username
  • password: The user's password

drive

This section (which can appear multiple times) contains configuration options about a specific virtual drive. The following options are currently supported:

  • name: The name of the drive the section is configuring. This should match the default name (e.g., 'Drive1').
  • newname: A new name to display for the drive

wifi.ap

When using the pISO as a WiFi hotspot, this section contains the name of the network and the password used to connect to it.

  • ssid: The name of the network broadcast by the pISO
  • password: The password users will need to enter to connect to the network

wifi.client

When connecting the pISO to an existing WiFi network, this section contains the password to use for a given network. Notice that this section can occur multiple times (the section name must be enclosed in two sets of '[').

  • ssid: The name of the network for the pISO to connect to
  • password: The password for that network