Skip to content

Commit

Permalink
docs: update documentation with latest changes
Browse files Browse the repository at this point in the history
Signed-off-by:  Eric Callahan <[email protected]>
  • Loading branch information
Arksine committed Jan 30, 2025
1 parent 0848fa1 commit 7e3c86e
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 5 deletions.
34 changes: 34 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,40 @@ The format is based on [Keep a Changelog].

## [Unreleased]

### Changed
- **data_store**: Store multi-line gcode commands in a single entry.
- **dbus_manager**: Replace unmaintained `dbus-next` requirement with
`dbus-fast`.
- **pip_utils**: Use the "upgrade" option when installing python packages.
This will force upgrades to the latest version available as resolved by
the requirement specifier.
- **wled**: Use the `async_serial` utility for serial comms.
- **paneldue**: Use the `async_serial` utility for serial comms.
- **scripts**: Update `fetch-apikey.sh` to query the SQL database

### Fixed
- **python_deploy**: fix "dev" channel updates for GitHub sources.

### Added
- **application**: Verify that a filename is present when parsing the
multipart/form-data for uploads.
- **application**: Log all failed HTTP API requests when verbose logging
is enabled.
- **install**: Support "requirement specifiers" for system packages.
Initially this is limited to restricting packages to a specific
distro version.
- **async_serial**: Basic asyncio wrapper around pyserial.
- **wled**: Add initial support for receiving responses.
- **scripts**: Add a `-g` option to `fetch-apikey.sh`. When specified
a new API Key will be generated and stored in the database. After
running this script it is necessary to restart Moonraker.
- **update_manager**: Report `name` and `configured_type` for all status
response types. This adds consistency and allows front-end devs to
simply iterate over the values of the `version_info` object.
- **python_deploy**: Add support for updating python packages with
"extras" installed.


## [0.9.3] - 2024-09-05

### Changed
Expand Down
18 changes: 15 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2150,9 +2150,10 @@ virtualenv:
# Path to the virtual enviromnent containing the python application.
project_name:
# Name of the python project as listed in the python package index. If
# the packaged is sourced from GitHub, this will be the name of the package
# when built. The default is the name specified by the configuration
# section.
# the packaged is sourced from GitHub, this will be the name of the project
# specified in the build. Optional "extras" may be added, see the tip
# follwing this example for details. The default is the name specified by the
# configuration section.
primary_branch:
# For packages sourced from GitHub, this option may be used to specify the
# branch to fetch updates from when the channel is set to "dev". The default
Expand All @@ -2164,6 +2165,17 @@ info_tags:
# options.
```

!!! Tip
Python packages with "extras" may be specified using the `project_name`
option. For example, assume we want to update a project named "pyapp"
that has an "extra" defined named "requests":
```
[update_manager pyapp]
type: python
project_name: pyapp[requests]
virtualenv: ~/pyapp
```

##### The optional release_info file

Python applications may include a `release_info` file in the package
Expand Down
19 changes: 17 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -586,13 +586,28 @@ Some clients may require an API Key to connect to Moonraker. After the
generate an API Key. There are two ways in which the key may be retrieved
by the user:

Retrieve the API Key via the command line (SSH):
#### Retrieve the API Key via the command line (SSH):
```
cd ~/moonraker/scripts
./fetch-apikey.sh
```

Retrieve the API Key via the browser from a trusted client:
Additionally its possible to generate a new API Key with the `-g`
option:

```
cd ~/moonraker/scripts
./fetch-apikey.sh -g
```

If Moonraker is running it must be restarted for the new API key to
take affect:

```
sudo systemctl restart moonraker
```

#### Retrieve the API Key via the browser from a trusted client:

- Navigate to `http://{moonraker-host}/access/api_key`, where
`{moonraker-host}` is the host name or ip address of the desired
Expand Down

0 comments on commit 7e3c86e

Please sign in to comment.