mirror of
				https://git.coolaj86.com/coolaj86/telebit.js.git
				synced 2025-11-03 10:12:46 +00:00 
			
		
		
		
	update windows instructions and error message
This commit is contained in:
		
							parent
							
								
									32e7f0af04
								
							
						
					
					
						commit
						b03717c312
					
				@ -130,6 +130,9 @@ Windows & Node.js
 | 
				
			|||||||
1. Install [node.js](https://nodejs.org)
 | 
					1. Install [node.js](https://nodejs.org)
 | 
				
			||||||
2. Open _Node.js_
 | 
					2. Open _Node.js_
 | 
				
			||||||
2. Run the command `npm install -g telebit`
 | 
					2. Run the command `npm install -g telebit`
 | 
				
			||||||
 | 
					2. Copy the example conifg to your user folder `.config/telebit/telebit.yml` (such as `/Users/John/.config/telebit/telebit.yml`)
 | 
				
			||||||
 | 
					2. Change the edaim address
 | 
				
			||||||
 | 
					2. Run `telebit daemon --config /Users/John/.config/telebit/telebit.yml`
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Note**: Use node.js v8.x or v10.x
 | 
					**Note**: Use node.js v8.x or v10.x
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -184,6 +187,11 @@ telebit tcp /module/path                # handle all tcp with a node module
 | 
				
			|||||||
telebit tcp none 6565                   # remove tcp handler from external port 6565
 | 
					telebit tcp none 6565                   # remove tcp handler from external port 6565
 | 
				
			||||||
telebit tcp 5050 6565                   # forward external port 6565 to local 5050
 | 
					telebit tcp 5050 6565                   # forward external port 6565 to local 5050
 | 
				
			||||||
telebit tcp /module/path 6565           # handle external port 6565 with a node module
 | 
					telebit tcp /module/path 6565           # handle external port 6565 with a node module
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					telebit ssh disable                     # disable ssh access
 | 
				
			||||||
 | 
					telebit ssh 22                          # port-forward all ssh connections to port 22
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					telebit save                            # save http and tcp configuration changes
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Using SSH
 | 
					### Using SSH
 | 
				
			||||||
 | 
				
			|||||||
@ -2,8 +2,8 @@ email: 'jon@example.com'        # must be valid (for certificate recovery and se
 | 
				
			|||||||
agree_tos: true                 # agree to the Telebit, Greenlock, and Let's Encrypt TOSes
 | 
					agree_tos: true                 # agree to the Telebit, Greenlock, and Let's Encrypt TOSes
 | 
				
			||||||
community_member: true          # receive infrequent relevant updates
 | 
					community_member: true          # receive infrequent relevant updates
 | 
				
			||||||
telemetry: true                 # contribute to project telemetric data
 | 
					telemetry: true                 # contribute to project telemetric data
 | 
				
			||||||
relay: wss://telebit.cloud      # Which Telebit Relay to use
 | 
					relay: telebit.cloud            # Which Telebit Relay to use
 | 
				
			||||||
secret: ''                      # Shared Secret with Telebit Relay for authorization
 | 
					#secret: ''                      # Shared Secret with Telebit Relay for authorization
 | 
				
			||||||
#token: ''                       # Token created by Telebit Relay for authorization
 | 
					#token: ''                       # Token created by Telebit Relay for authorization
 | 
				
			||||||
ssh_auto: 22                    # forward ssh-looking packets, from any connection, to port 22
 | 
					ssh_auto: 22                    # forward ssh-looking packets, from any connection, to port 22
 | 
				
			||||||
servernames:                    # hostnames that direct to the Telebit Relay admin console
 | 
					servernames:                    # hostnames that direct to the Telebit Relay admin console
 | 
				
			||||||
							
								
								
									
										7
									
								
								examples/telebit.minimal.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								examples/telebit.minimal.yml
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,7 @@
 | 
				
			|||||||
 | 
					email: 'jon@example.com'        # must be valid (for certificate recovery and security alerts)
 | 
				
			||||||
 | 
					agree_tos: true                 # agree to the Telebit, Greenlock, and Let's Encrypt TOSes
 | 
				
			||||||
 | 
					community_member: true          # receive infrequent relevant updates
 | 
				
			||||||
 | 
					telemetry: true                 # contribute to project telemetric data
 | 
				
			||||||
 | 
					relay: telebit.cloud            # Which Telebit Relay to use
 | 
				
			||||||
 | 
					#secret: ''                      # Shared Secret with Telebit Relay for authorization
 | 
				
			||||||
 | 
					#token: ''                       # Token created by Telebit Relay for authorization
 | 
				
			||||||
@ -217,8 +217,8 @@ module.exports.assign = function (state, tun, cb) {
 | 
				
			|||||||
        handler = require(path.join(localshare, handlerpath));
 | 
					        handler = require(path.join(localshare, handlerpath));
 | 
				
			||||||
        console.info("Handling '" + handle + ":" + id + "' with '" + handlerpath + "'");
 | 
					        console.info("Handling '" + handle + ":" + id + "' with '" + handlerpath + "'");
 | 
				
			||||||
      } catch(e2) {
 | 
					      } catch(e2) {
 | 
				
			||||||
        console.error("Failed to load '" + handlerpath + "':", e1.message);
 | 
					        console.error("Failed to require('" + handlerpath + "'):", e1.message);
 | 
				
			||||||
        console.error("Failed to load '" + path.join(localshare, handlerpath) + "':", e2.message);
 | 
					        console.error("Failed to require('" + path.join(localshare, handlerpath) + "'):", e2.message);
 | 
				
			||||||
        console.warn("Using default handler for '" + handle + ":" + id + "'");
 | 
					        console.warn("Using default handler for '" + handle + ":" + id + "'");
 | 
				
			||||||
        echoTcp(cb);
 | 
					        echoTcp(cb);
 | 
				
			||||||
      }
 | 
					      }
 | 
				
			||||||
@ -271,8 +271,8 @@ module.exports.assign = function (state, tun, cb) {
 | 
				
			|||||||
        handler = require(path.join(localshare, handlerpath));
 | 
					        handler = require(path.join(localshare, handlerpath));
 | 
				
			||||||
        console.info("Handling '" + handle + ":" + id + "' with '" + handlerpath + "'");
 | 
					        console.info("Handling '" + handle + ":" + id + "' with '" + handlerpath + "'");
 | 
				
			||||||
      } catch(e2) {
 | 
					      } catch(e2) {
 | 
				
			||||||
        console.error("Failed to load '" + handlerpath + "':", e1.message);
 | 
					        console.error("Failed to require('" + handlerpath + "'):", e1.message);
 | 
				
			||||||
        console.error("Failed to load '" + path.join(localshare, handlerpath) + "':", e2.message);
 | 
					        console.error("Failed to require('" + path.join(localshare, handlerpath) + "'):", e2.message);
 | 
				
			||||||
        console.warn("Using default handler for '" + handle + ":" + id + "'");
 | 
					        console.warn("Using default handler for '" + handle + ":" + id + "'");
 | 
				
			||||||
        handler = null;
 | 
					        handler = null;
 | 
				
			||||||
        // fallthru
 | 
					        // fallthru
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user