Commit 2981f312 authored by Claude's avatar Claude 🌴

Update documentation

parent 2cbd4258
Pipeline #8158 passed with stage
in 30 seconds
......@@ -103,56 +103,8 @@ Optionally you can customize **Prepare Raspbian SD**.
You have two options to customize default download directory, witch is location where images will be store.
To be able to use `--configure` properly, you must choose how and what you want to configure.
See [prepare-raspbian-sd-config.md](prepare-raspbian-sd-config.md) for more details.
```bash
_DATA_="$( xdg-user-dir DOCUMENTS )/raspbian-images"
_DOWNLOAD_="${_DATA_}/download"
_BACKUP_="${_DATA_}/backups"
# Create directories if needed
mkdir -vp "${_DOWNLOAD_}" "${_BACKUP_}"
# Configuration (recommended)
prepare-raspbian-sd-config RASPBIAN_DEFAULT_BACKUP_DIRECTORY "${_BACKUP_}"
prepare-raspbian-sd-config RASPBIAN_DEFAULT_DOWNLOAD_IMAGE_DIRECTORY "${_DOWNLOAD_}"
prepare-raspbian-sd-config SSH_AUTHORIZED_KEYS "$( cat ~/.ssh/id_rsa.pub )"
# Configuration (optional - if used ensure value is what you want)
prepare-raspbian-sd-config DEFAULT_SD_DEV_NAME 'mmcblk0'
prepare-raspbian-sd-config GPU_MEM '16'
prepare-raspbian-sd-config RASPBIAN_DEFAULT_IMG "${_DOWNLOAD_}/2019-07-10-raspbian-buster-lite.img"
```
Or you can export required variables (using `~/.bashrc` or custom script):
```bash
export RASPBIAN_SSH_CONFIG='/path/to/your-ssh-need.config'
```
* If `RASPBIAN_DEFAULT_BACKUP_DIRECTORY` not define, commands your `Documents` directory.
* If `RASPBIAN_DEFAULT_DOWNLOAD_IMAGE_DIRECTORY` not define, commands use your `Download` directory.
### Summary
| Variable name | Usage description | Typical values |
|---------------------------------------------|-------------------------------------------|----------------|
| `DEFAULT_SD_DEV_NAME` | Optional, use to write on SD card. | `mmcblk0` |
| `GPU_MEM` | Optional, use by `--configure`. Configure memory split, if not set or if set to 0 memory split configuration is skipped | `16` |
| `RASPBIAN_DEFAULT_BACKUP_DIRECTORY` | Required to be able to use `--full-clone`. Variable must contain full path of an existing directory where your SD backups will be stored. | `/home/username/Documents/` |
| `RASPBIAN_DEFAULT_DOWNLOAD_IMAGE_DIRECTORY` | Nice to have to use `--download` option of **prepare-raspbian-sd-download-image** and to use `--put-last-image` option of **prepare-raspbian-sd**. | `/home/username/Documents/raspbian-images` |
| `RASPBIAN_DEFAULT_IMG` | Required to be able to use `--put-default-image`. Variable must contain full path to your `raspbian-stretch-lite.img` local file. | `/path/to/2018-10-09-raspbian-stretch-lite.img` |
| `RASPBIAN_PI_GROUP_ID` | Optional, default value 1000 | `1000` |
| `RASPBIAN_PI_USER_ID` | Optional, default value 1000 | `1000` |
| `SSH_AUTHORIZED_KEYS` | Required to be able to use `--configure`. Variable must contain content of `/home/pi/.ssh/authorized_keys` you want to add. | `"$( cat ~/.ssh/id_rsa.pub )"` |
Deprecated configuration entry point:
| Variable name | Usage description |
|---------------------------------------------|---------------------------------------------------|
| `RASPBIAN_SSH_CONFIG` | Is deprecated. Use `SSH_AUTHORIZED_KEYS` instead. |
See [prepare-raspbian-sd-config.md](prepare-raspbian-sd-config.md) for more details.
## Usage
......
......@@ -82,12 +82,8 @@ export RASPBIAN_SSH_CONFIG='/path/to/your-ssh-need.config'
| `RASPBIAN_PI_GROUP_ID` | Optional, default value 1000 | `1000` |
| `RASPBIAN_PI_USER_ID` | Optional, default value 1000 | `1000` |
| `SSH_AUTHORIZED_KEYS` | Required to be able to use `--configure`. Variable must contain content of `/home/pi/.ssh/authorized_keys` you want to add. | `"$( cat ~/.ssh/id_rsa.pub )"` |
Deprecated configuration entry point:
| Variable name | Usage description |
|---------------------------------------------|---------------------------------------------------|
| `RASPBIAN_SSH_CONFIG` | Is deprecated. Use `SSH_AUTHORIZED_KEYS` instead. |
| `SSH_CONFIGURE` | Optional, if set to true create `~/.ssh directory` | `true` |
| `SSH_ENABLE` | Optional, if set to true enable sshd. | `true` |
## Related documentation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment