Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Writing a complete guide on how to use Replibyte #61

Open
evoxmusic opened this issue Apr 26, 2022 · 6 comments
Open

Writing a complete guide on how to use Replibyte #61

evoxmusic opened this issue Apr 26, 2022 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@evoxmusic
Copy link
Contributor

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
@evoxmusic evoxmusic added the documentation Improvements or additions to documentation label Apr 26, 2022
@fabriceclementz
Copy link
Contributor

@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
Copy link
Contributor Author

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
Copy link
Contributor Author

It's almost done :)

@ptrhck
Copy link

ptrhck commented Jul 21, 2022

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

@evoxmusic
Copy link
Contributor Author

Did you check out www.replibyte.com ?

@ptrhck
Copy link

ptrhck commented Jul 21, 2022

Yes, did I miss that section?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants