Skip to content

Commit

Permalink
updating faq and readme (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
autodidaddict authored Mar 15, 2024
1 parent 3d19fb5 commit 55ae3df
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ The following is a list of the features that make Natster both powerful and uniq
* Global Service - We host a service in a well-known account that is available to everyone with a Synadia Cloud account, running on top of [nex](https://github.com/synadia-io/nex). We don't need to worry about setting up, deploying, and securing a RESTful API. With Synadia Cloud/NATS, we can just export a service and we get security and availability for free.
* Natster Hub - We host a catalog pre-filled with useful videos and informative content on NATS, Natster, and Nex. We didn't need to do anything special to make this happen, the hub is just another Synadia Cloud account running a secure catalog server.

More documentation will be forthcoming.
For more detailed information, please check out the documentation at [docs.natster.io](https://docs.natster.io)
17 changes: 14 additions & 3 deletions docs/content/faq/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,21 @@ weight: 10

{{< toc format=html >}}

Under construction!
The following is a list of frequently asked questions about Natster

## How long did it take to make Natster?
It took a team of 3 people 3 weeks to make. An additional week was used to write the documentation, test user flows, find and fix bugs, and generally make it suitable for public use.

## What's all this talk about prizes?
At Kubecon EU 2024 in Paris, we will be giving away prizes in random drawings to anyone who has successfully imported a shared catalog. We'll notify the winners by updating a `winners.txt` file in the `synadiahub` shared catalog.
## 🎁 What's all this talk about prizes?
At Kubecon EU 2024 in Paris, we will be giving away prizes in random drawings to anyone who has successfully imported a shared catalog. We'll notify the winners by updating a `contest.txt` file in the `synadiahub` shared catalog.

## Why doesn't Natster use object stores for the media files?
Given our motto of _"Nothin' but NATS"_, it definitely seems like we should've used object stores. From a technical standpoint, there's nothing preventing us from doing this. The main reason why the catalog servers only serve _local_ files is to ensure that none of your private files are ever stored in the cloud, even in your own account. Media libraries can also become incredibly large and it might be easy to go over the free account quota with a big enough object store.

## What are all these really long alphanumeric keys?
Throughout the tutorials and your use of Natster as well as Synadia Cloud, you will frequently see keys with 56 characters made up of upper case letters and numbers, like **ACTZW5NQGNUQHWDFNPBPROEC4HJO76K7H3QRARK4DWA2P2KBJEHRCUT2**. These aren't just randomly generated bytes. They are actually **[ed25519 keys](https://docs.nats.io/running-a-nats-service/configuration/securing_nats/auth_intro/nkey_auth)** that have a special encoding to make them both URL-friendly and double-clickable.

When designing Natster, we decided to use the already secure, decentralized authentication system that comes with NATS out of the box. That choice meant we didn't have to write our own security tier.

## Is Natster a real product? Is it supported?
Natster is a demonstration application. It is an open source _reference application_ created to illustrate a number of powerful design patterns when building distributed systems on top of NATS. While we will of course try and maintain a reliable level of service, there is no guarantee that Natster will continue operating at all times.

0 comments on commit 55ae3df

Please sign in to comment.