Option to use S3 for storage

Open
#15 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
aws
Domain
backend, cloud

Research direction

Review the setup around feedland.js and the privateFiles directory, then read config.json and the linked config.md entries for flUseS3ForStorage and s3PathForStorage. Confirm whether S3-backed handling for prefs.json and bookmarks.opml is present and identify any remaining behavior to document or test.

Written by the indexing model from the issue text.

Description

If you look in the directory that contains feedland.js you will see a privateFiles sub-directory. There's one sub-folder for each user with an account.

There are two types of files it could contain:

  1. prefs.json -- very user will have this.
  2. bookmarks.opml -- if you're using bookmarks, you'll have one of these.

We found that we need the option to save these files in S3 instead of on the local machine, so I added a new config.json value, flUseS3ForStorage. If it's true, you must also provide a value for s3PathForStorage. And we will save files on S3 where you specify.

There are docs for these, here.

Dominant language
HTML
Stars
11
Forks
4
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from scripting/feedlandInstall

All issues in scripting/feedlandInstall

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.