Skip to content

Commit

Permalink
Add few more configuration arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
Sameer Kulkarni committed Dec 13, 2023
1 parent b6c56f3 commit b999dd5
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 20 deletions.
30 changes: 19 additions & 11 deletions Acornfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,22 @@ icon: "./plex-icon.png"

args: {
scale: 1
// Plex Claim Token
// required: Plex Claim Token
plexserver_claim: ""
// Plex Media Storage Size
storage: "2G"
// Wasabi S3 Access Key
access_key: ""
// Wasabi S3 Secret Key
secret_key: ""
// Wasabi S3 Bucket Name
bucket_name: ""
// Schedule Job to run daily
rclone_schedule: "@daily"
// Optional: Plex media volume size
storage: "2G"
// Required: Wasabi bucket name
bucket_name: ""
// Required: Wasabi bucket region. Default: us-east-1
region: "us-east-1"
// Required: Wasabi bucket url. Default: s3.wasabisys.com
endpoint_url: "s3.wasabisys.com"
// Required: Wasabi access key
access_key: ""
// Required: Wasabi secret key
secret_key: ""
// Optional: Bucket sync job cron schedule. Default: every 6 hours.
rclone_schedule: "0 */6 * * *"
}

containers: {
Expand Down Expand Up @@ -60,6 +64,8 @@ jobs: {
AWS_ACCESS_KEY_ID: args.access_key
AWS_SECRET_ACCESS_KEY: args.secret_key
AWS_S3_BUCKET: args.bucket_name
REGION: args.region
ENDPOINT_URL: args.endpoint_url
}
dirs: {
"./rclone-config-script.sh": "./rclone-config-script.sh"
Expand All @@ -74,6 +80,8 @@ jobs: {
AWS_ACCESS_KEY_ID: args.access_key
AWS_SECRET_ACCESS_KEY: args.secret_key
AWS_S3_BUCKET: args.bucket_name
REGION: args.region
ENDPOINT_URL: args.endpoint_url
}
dirs: {
"./rclone-config-script.sh": "./rclone-config-script.sh"
Expand Down
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Acorn for a Plex App

Plex Media Server (usually just called Plex) is a digital media player and organizational tool that allows you to your entire digital library from any compatible computer, smartphone, or streaming device, without the need to transfer files manually. Using Acorn, you can host your own Plex Media Server and use a Wasabi S3 storage to store the media.
[Plex Media Server](https://www.plex.tv/media-server-downloads/) (usually just called Plex) is a digital media player and organizational tool that allows you to your entire digital library from any compatible computer, smartphone, or streaming device, without the need to transfer files manually. Using Acorn, you can host your own Plex Media Server and use a Wasabi S3 storage to store the media.

## Wasabi
[Wasabi](https://wasabi.com/hot-cloud-storage/) is one of the most affordable online storage options available. You can store all of your media on it with as little as $6.99 TB/Month, with no egress charges.

## Running Plex Acorn

Expand All @@ -10,9 +13,13 @@ You can create your own Wasabi S3 bucket by signing up on Wasabi and access it u

## Arguments for Running Plex

plexserver_claim: Plex Claim to add the server ( https://www.plex.tv/claim/ ). Note : The claim expires after every 10mins
storage: Plex Media storage Size
access_key: Wasabi S3 Access Key
secret_key: Wasabi S3 Secret Key
bucket_name: Wasabi S3 Bucket Name
rclone_schedule: Rclone Job schedule to periodically sync the Wasabi S3 bucket with Plex Media Volume
| Argument | required? | Description | Default Value |
|---|---|---|---|
| plexserver_claim | Y | Plex Claim to add the server ( https://www.plex.tv/claim/ ). Note : The claim expires after every 10mins | NA |
| storage | N | Plex Media storage Size | 2G |
| region | Y | Wasabi S3 bucket region | us-east-1 |
| endpoint_url | Y | Wasabi S3 bucket url | s3.wasabisys.com |
| access_key | Y | Wasabi S3 Access Key | NA |
| secret_key | Y | Wasabi S3 Secret Key | NA |
| bucket_name | Y | Wasabi S3 Bucket Name | NA |
| rclone_schedule | N | Rclone Job schedule to periodically sync the Wasabi S3 bucket with Plex Media Volume | `0 */6 * * *` i.e. Every 6 hours |
4 changes: 2 additions & 2 deletions rclone-config-script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ type = s3
provider = Wasabi
access_key_id = $AWS_ACCESS_KEY_ID
secret_access_key = $AWS_SECRET_ACCESS_KEY
region = us-east-1
endpoint = s3.wasabisys.com
region = $REGION
endpoint = $ENDPOINT_URL
EOF

Expand Down

0 comments on commit b999dd5

Please sign in to comment.