Comments (3)
The documentation on how to fully setup everything end to end unfortunately is a bit lacking.
Yes, this need to be improved.
I am creating this issue to track improvements in documentation.
It's fine and let's keep it open. This would be a long-term issue.
I will definitely help on the English side/work with the team to translate as best as possible/submit PRs for them. Also I would like to help submit new example configs as well.
Thanks
@zh-jq - would you like me to create new issues for all areas that are needing documentation or should we keep that just under this main issue?
For big parts I'm OK with both the way. For small parts you can just submit PRs directly.
How would I use g3proxy to do forward proxying with SSL inspection? (Needing to use g3fcgen etc).
I have updated the user guide this week and you can check that again.
How do I configure a “frontend” with g3fcgen?
I will add a README for g3fcgen next week.
@zh-jq if it’s easier to quickly right your docs in Chinese I can use tools to translate - but will need to have you review for accuracy.
Thanks again.
I'm not good at writing even in Chinese. I will try my best to do that. Let me know if you have suggestions on the organization of the docs, or have confusion on the missing parts, or want to see more comments for some specific code.
from g3.
Along the lines of documentation - I am working on adding more debugging statements in the code/libraries. I am currently using log::debug. For example in g3-icap-client these are the type of comments (see below). Is this format OK with you?
impl IcapServiceClient {
pub fn new(config: Arc<IcapServiceConfig>) -> Self {
debug!("Creating new IcapServiceClient");
let (cmd_sender, cmd_receiver) = flume::unbounded();
from g3.
I'm OK with this. But only essential ones should be added.
from g3.
Related Issues (20)
- Evaluate Profile-Guided Optimization (PGO) and LLVM BOLT HOT 1
- 后续可以支持PPV1 吗 HOT 1
- 请教完整的tlcp代理示例 HOT 3
- g3proxy: Ability to change ClientHello sent to upstream server HOT 18
- Track upstream features that we want to use
- Docker container support HOT 2
- 配置文件存放路径文档不对 HOT 2
- Issues with SSL interception HOT 8
- ICAP issues HOT 3
- Bump g3fcgen version to v0.6.3 release HOT 1
- Feature Request: Full remote certificate inspection and duplication for TLS MITM HOT 2
- Allow hostnames in the config HOT 5
- Issues with TLS Stream Dump HOT 3
- g3-io-ext 编译出错 HOT 2
- Ability to disable HTTP2 connections? HOT 3
- How do I add an upstream certificate for proxy chaining? HOT 2
- G3 panics in src/g3proxy/src/inspect/stream/object.rs HOT 1
- Certain sites fail to load if browser is using HTTP1 via G3proxy HOT 4
- G3proxy is unable to connect to g3fcgen on MacOS
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from g3.