Skip to content

✨ Make configuration of middleware#10

Merged
buttercrab merged 3 commits intomainfrom
middleware_dev
Aug 30, 2021
Merged

✨ Make configuration of middleware#10
buttercrab merged 3 commits intomainfrom
middleware_dev

Conversation

@buttercrab
Copy link
Copy Markdown
Collaborator

@buttercrab buttercrab commented Aug 25, 2021

  • removed main.rs (middleware is library)
  • added small documentation for middleware (features of middleware)
  • added configuration for server
  • added configuration for auth server
  • added documents for configuration
  • added example for using Config and AuthServer
  • added function to make rustls::ServerConfig (todo)
  • reformatted Cargo.toml and added include part of package in
    Cargo.toml
  • will be using tokio + rustls for connection in connection
  • changed comments to doc comments
  • removed make_tls_config function
  • changed rustls::ServerConfig to key_path and cert_path
  • removed custom_debug_derive dependency
  • added serde dependency
  • changed example in document

Since there was no actual code running, no test was written.

- removed main.rs (middleware is library)
- added small documentation for middleware (features of middleware)
- added configuration for server
- added configuration for auth server
- added documents for configuration
- added example for using `Config` and `AuthServer`
- added function to make `rustls::ServerConfig` (todo)
- reformatted Cargo.toml and added `include` part of `package` in
  Cargo.toml
- will be using tokio + rustls for connection in connection

Since there was no actual code running, no test was written.
@buttercrab buttercrab self-assigned this Aug 25, 2021
@buttercrab buttercrab marked this pull request as draft August 25, 2021 17:26
- changed comments to doc comments
- removed `make_tls_config` function
- changed `rustls::ServerConfig` to `key_path` and `cert_path`
- removed `custom_debug_derive` dependency
- added `serde` dependency
- changed example in document
@buttercrab buttercrab marked this pull request as ready for review August 26, 2021 09:42
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

Merging #10 (9eb477a) into main (5a93a06) will increase coverage by 5.12%.
The diff coverage is 40.00%.

@@            Coverage Diff             @@
##             main      #10      +/-   ##
==========================================
+ Coverage   33.33%   38.46%   +5.12%     
==========================================
  Files           3        4       +1     
  Lines           9       26      +17     
  Branches        0       11      +11     
==========================================
+ Hits            3       10       +7     
- Misses          6       16      +10     

@sboh1214 sboh1214 changed the title ✨ made configuration ✨ Make configuration of middleware Aug 27, 2021
Copy link
Copy Markdown
Collaborator

@sboh1214 sboh1214 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I modified the title to start with a simple present verb and have more information.

@buttercrab buttercrab requested review from minchurl and utilForever and removed request for minchurl and utilForever August 28, 2021 14:21
Copy link
Copy Markdown
Member

@utilForever utilForever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Next time, you should add some blank lines to improve readability. 📓

@buttercrab buttercrab merged commit 7e9467d into main Aug 30, 2021
@buttercrab buttercrab deleted the middleware_dev branch August 30, 2021 05:14
@minchurl
Copy link
Copy Markdown
Collaborator

minchurl commented Aug 31, 2021

I suggest to change a small things.

- //!        .auth_config(AuthServer::builder().password("password").build().unwrap())
+ //!        .auth_config(AuthServer::builder().password("<your password>").build().unwrap())

at the middleware/src/config.rs line 13
because many user just copy&paste if there is no word such as 'your'.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants