Skip to content

Commit

Permalink
include warning about EBS media volume size
Browse files Browse the repository at this point in the history
  • Loading branch information
jdtriska committed Mar 27, 2020
1 parent 62a4a46 commit 08a30a8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Forgive me, some of these are basic, but I list them here for less technical use
* `AWS_ACCESS_KEY_ID`: This is your access key ID from AWS. See _Prequisites_ for instructions on getting this.
* `AWS_REGION`: This is the AWS region in which your Jellyfin instance will run. This should be close to where you'll be streaming the most from. See [this page](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) for an overview of possible regions. You must use the lowercase-and-hyphen form of the region, e.g. `us-east-1`.
* `AWS_SECRET_ACCESS_KEY`: This is your secret access key from AWS. See _Prequisites_ for instructions on getting this.
* `EBS_MEDIA_VOLUME_SIZE`: This is the size of the drive that will be attached to the EC2 instance as a media storage drive, specified in gigabytes (GiB). Your media is syncronized to this drive, so it must be large enough to store everything you plan to upload.
* `EBS_MEDIA_VOLUME_SIZE`: This is the size of the drive that will be attached to the EC2 instance as a media storage drive, specified in gigabytes (GiB). Your media is syncronized to this drive, so it must be large enough to store everything you plan to upload. **WARNING**: Please make sure this is a different size than specified in `EBS_ROOT_VOLUME_SIZE`. Because of [the way AWS handles volume naming](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html), we use this unique volume size to detect the media volume and mount it as your `~/jellyfin/media` folder.
* `EBS_MEDIA_VOLUME_TYPE`: This is the type of drive AWS will attach to your EC2 instance as the media volume. Valid values are `gp2`, `io1`, `st1`, and `sc1`. I'd recommend `st1` for large drives, and `gp2` for small drives. See https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html for a description of drive types.
* `EBS_ROOT_VOLUME_SIZE`: This is the size of the drive that will be the root volume for your jellyfin instance, in gigabytes (GiB). It just needs enough space for working files. I'd recommend something on the order of `8`.
* `EC2_INSTANCE_TYPE`: This is the type and size of the server you'll be running the Jellyfin instance on. See https://aws.amazon.com/ec2/instance-types/ for details on what types of instances are available. I would recommend something relatively small to start, especially if you're planning to primarily direct stream media instead of having Jellyfin transcode. The instance types should be of the form `type.size`, for instance `t3a.small`, which would make a good starting instance type. **WARNING**: This will affect your running cost significantly so make sure to calculate this ahead of time to avoid unwanted billing surprises.
Expand Down

0 comments on commit 08a30a8

Please sign in to comment.