search

Qovery / Replibyte

Seed your development database with real data ⚡️
https://www.replibyte.com
GNU General Public License v3.0
4.16k stars 128 forks source link

Writing a complete guide on how to use Replibyte #61

Open evoxmusic opened 2 years ago

evoxmusic commented 2 years ago

I think we have reached a good milestone (big thanks to @fabriceclementz and @benny-n). It's the perfect time to show how to use RepliByte. Writing an article covering the basics (backup, restore, transformer, subset) and some more advanced use cases (E.g. using wasm transformer) of Replibyte would be greatly appreciated by any user that wants to get started.

Here is an example of a guide structure that can be used:

  1. Install Replibyte (MacOSX, Linux, Windows)
  2. Create an account on AWS S3 (or equivalent)
  3. Create a dev dataset 3.a Create a dev dataset from the production database 3.b Create a dev dataset from a dump 3.c Hide sensitive data 3.d Subset (optional)
  4. Run RepliByte in a Docker container
  5. Deploy RepliByte 5.a Explain how to set Replibyte with a cron to get a fresh dev dataset every day / week / month...
  6. Use a dev dataset 6.a Restore a dev dataset in a local container 6.b Restore in a remote database
  7. Create a custom transformer
fabriceclementz commented 2 years ago

@evoxmusic Seems like a good way to attract more users. I saw you've started to write it on discord. Let me know if you need help for some parts.

evoxmusic commented 2 years ago

Thank you @fabriceclementz - I keep you posted. Basically I think to create a general getting started guide and then create more specific use case guide.

evoxmusic commented 2 years ago

It's almost done :)

ptrhck commented 2 years ago

This would be really great! I would also like to know what is best practice on authentication, especially with AWS RDS.

evoxmusic commented 2 years ago

Did you check out www.replibyte.com ?

ptrhck commented 2 years ago

Yes, did I miss that section?