Neofrp Documentation
Getting Started
1. Create an Account
Register for a new account using the sign-up page. The first user to register will automatically receive administrator privileges.
2. Create Tunnels
Navigate to the Tunnels page and create new port forwarding rules. Each tunnel consists of:
- Name: A descriptive identifier for your tunnel
- Local Port: The port on your local machine
- Server Port: The public port on the server
3. Generate Configuration
Go to the Configurations page and generate a client configuration file. This will include all your active tunnels and authentication token.
4. Run the Client
./frpc -c client.json
Common Use Cases
Web Server
Expose a local web server running on port 80:
Protocol: TCP
Local Port: 80
Server Port: 8080
SSH Access
Enable remote SSH access to your machine:
Protocol: TCP
Local Port: 22
Server Port: 2222
Database Access
Allow remote access to a local database:
Protocol: TCP
Local Port: 3306/5432
Server Port: Any available
Security Considerations
- Keep your authentication token secure and never share it
- Use QUIC protocol when possible for better security
- Regularly review and disable unused tunnels
- Consider using additional authentication for exposed services