nemo
/
forteller-dl
mirror of https://github.com/captn3m0/foreteller-dl.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Nemo 2022-04-30 11:40:23 +00:00 committed by GitHub
parent 39b32b6622
commit c696c6a31c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -34,9 +34,20 @@ In the commands that follow, please replace SKU with the correct SKU from the le
### Running using Docker
Make sure you have configured your credentials as per the above.
#### Login to the GitHub Container Registry:
1. Create a new [Personal Access Token](https://github.com/settings/tokens/new?scopes=read:packages&description=Docker%20Login) with the `read:packages` scope.
2. Run `docker login ghcr.io`. Put your GitHub username as the username, and the token you generated above as the password.
#### Downloading files using Docker
Change `$HOME/Downloads` to the directory where you'd like the files to be written. A directory is automatically created here for whichever SKU you download.
```sh
# Set SKU to one of `ceph_gh`,`ceph_jaws`,`suc_mid1`,`ceph_fh`,`skg_iso`
docker run -it --init --volume "$HOME/Downloads:/downloads" --env-file .env ghcr.io/captn3m0/forteller-dl:main SKU /downloads
docker run -it --init --user $UID --volume "$HOME/Downloads:/downloads" --env-file .env ghcr.io/captn3m0/forteller-dl:main SKU /downloads
```
### Running using local PHP
@ -63,4 +74,4 @@ The script is functional enough for me, so this will likely never get done. But
## License
Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.
Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.