jbiason
/
Memoirs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Shared IP and PORT

main
Julio Biason 2 years ago
parent
95dc6fe224
commit
c761a07b7d
9 changed files with 33 additions and 16 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      design/caldav.md
  2. 2
      design/deezer.md
  3. 2
      design/email.md
  4. 3
      design/guildwars2.md
  5. 3
      design/mastodon.md
  6. 3
      design/netflix.md
  7. 3
      design/rss.md
  8. 3
      design/steam.md
  9. 27
      design/store.md

3
design/caldav.md
Unescape View File

@ -6,7 +6,8 @@ CalDav uses the [iCalendar](https://en.wikipedia.org/wiki/ICalendar) format.
## Configuration ## Configuration
The CalDav capturer needs the URL for the CalDav. The CalDav capturer needs the URL for the CalDav, besides the IP and PORT of
Store.
## Internals ## Internals

2
design/deezer.md
Unescape View File

@ -8,7 +8,7 @@ user.
## Configuration ## Configuration
Configuration requires the OAuth token. Configuration requires the OAuth token, besides the IP and PORT of the Store.
## Internals ## Internals

2
design/email.md
Unescape View File

@ -13,6 +13,8 @@ The Capturer will require:
- Username - Username
- Password - Password
... besides the IP and PORT of the Store.
**Note**: We may need to support IMAPS. **Note**: We may need to support IMAPS.
## Internals ## Internals

3
design/guildwars2.md
Unescape View File

@ -5,7 +5,8 @@ completed achievements and play time.
## Configuration ## Configuration
The only required configuration is the access token. The only required configuration is the access token, besides the IP and PORT of
the Store.
## Internals ## Internals

3
design/mastodon.md
Unescape View File

@ -6,7 +6,8 @@ private and such, which seem better.
## Configuration ## Configuration
The only required configuration is the access token. The only required configuration is the access token, besides the IP and PORT of
the Store.
## Internals ## Internals

3
design/netflix.md
Unescape View File

@ -6,7 +6,8 @@ There is no API. We need to scrap the user account page to find that out.
## Configuration ## Configuration
Sadly, we may need username and password in the configuration. Sadly, we may need username and password in the configuration, besides the IP
and PORT of the Store.
## Internals ## Internals

3
design/rss.md
Unescape View File

@ -6,7 +6,8 @@ Markdown (although I've done this before, using
## Configuration ## Configuration
The only required configuration is the feed URL. The only required configuration is the feed URL, besides the IP and PORT of the
Store.
## Internals ## Internals

3
design/steam.md
Unescape View File

@ -8,7 +8,8 @@ be captured.
## Configuration ## Configuration
The only required configuration is the Steam ID. The only required configuration is the Steam ID, besides the IP and PORT of the
Store.
## Internals ## Internals

27
design/store.md
Unescape View File

@ -4,9 +4,18 @@ The Store is the central point of the application. It is responsible for
keeping all the information sent by Capturers and providing a search/list keeping all the information sent by Capturers and providing a search/list
functionality for Viewers. functionality for Viewers.
## Configuration
We would need, at least (probably in envvars):
- `IP`: Binding IP for the server.
- `PORT`: Binding port for the server.
## Internals
We would probably need a design like: We would probably need a design like:
## Entry ### Entry
| Field | Description | | Field | Description |
| ------- | --------------------------------------------------- | | ------- | --------------------------------------------------- |
@ -15,7 +24,7 @@ We would probably need a design like:
| content | Text, produced by a Capturer. It's always Markdown. | | content | Text, produced by a Capturer. It's always Markdown. |
| source | Capturer name. | | source | Capturer name. |
## Meta ### Meta
Meta contains the meta information of the entry, used by a Capturer. A view may Meta contains the meta information of the entry, used by a Capturer. A view may
or may not display those fields. or may not display those fields.
@ -27,14 +36,14 @@ or may not display those fields.
| name | Meta field name. | | name | Meta field name. |
| value | Meta field value. | | value | Meta field value. |
## Attachments ### Attachments
Attachments are not meta information, but something related to the entry -- for Attachments are not meta information, but something related to the entry -- for
example, if the content contains any images, those are added as attachments. example, if the content contains any images, those are added as attachments.
| Field | Description | | Field | Description |
| ------------ | --------------------------------------------------- | | ------------- | --------------------------------------------------- |
| id | UUID of the record. | | id | UUID of the record. |
| entry | ForeignKey of the entry. | | entry | ForeignKey of the entry. |
| content_type | Type of the content. | | content\_type | Type of the content. |
| content | Attachment content, in Base64. | | content | Attachment content, in Base64. |

Write Preview
Loading…
Cancel
Save