https://github.com/simp-lee/browser
A Go library for managing browser instances with rod, supporting pooling, headless mode, proxies, cookies, and auto timeout.
https://github.com/simp-lee/browser
browser go golang rod
Last synced: 3 months ago
JSON representation
A Go library for managing browser instances with rod, supporting pooling, headless mode, proxies, cookies, and auto timeout.
- Host: GitHub
- URL: https://github.com/simp-lee/browser
- Owner: simp-lee
- Created: 2024-07-10T13:42:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-16T07:00:41.000Z (about 1 year ago)
- Last Synced: 2025-03-03T09:26:21.555Z (8 months ago)
- Topics: browser, go, golang, rod
- Language: Go
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Browser Package
This package provides a high-level API for managing and interacting with browser instances using the [rod](https://github.com/go-rod/rod) library. It supports features such as browser pooling, headless mode, proxy configuration, cookies, and automatic idle timeout.
## Installation
To install the package, use `go get`:
```sh
go get -u github.com/simp-lee/browser
```
## Usage
### Basic Usage
Here's a basic example of how to use the package:
```go
package main
import (
"fmt"
"github.com/simp-lee/browser"
"time"
)
func main() {
// Get a browser instance with default options
b, err := browser.GetBrowser()
if err != nil {
panic(err)
}
defer b.Close()
// Get a page instance from the browser
page, err := b.GetPage()
if err != nil {
panic(err)
}
defer b.PutPage(page)
page.MustNavigate("https://example.com")
fmt.Println(page.MustInfo().Title)
}
```
### Configuring Browser Options
You can configure various options for the browser instance:
```go
package main
import (
"github.com/simp-lee/browser"
"time"
)
func main() {
// Get a browser instance with custom options
b, err := browser.GetBrowser(
browser.WithHeadless(false),
browser.WithProxy("127.0.0.1:8080"),
browser.WithPoolSize(5),
browser.WithIdleTimeout(10*time.Minute),
)
if err != nil {
panic(err)
}
defer b.Close()
}
```
### Configuring Page Options
You can configure various options for the page instance:
```go
package main
import (
"fmt"
"github.com/simp-lee/browser"
)
func main() {
// Get a browser instance with default options
b, err := browser.GetBrowser()
if err != nil {
panic(err)
}
defer b.Close()
// Get a page instance with custom options
page, err := b.GetPage(
browser.WithUserAgent("CustomUserAgent"),
browser.WithReferer("https://example.com"),
browser.WithViewport(1920, 1080, 1.0, false),
browser.WithExtraHeaders(map[string]string{
"X-Custom-Header": "custom_value",
}),
browser.WithCookies(browser.Cookie{
Name: "example_cookie",
Value: "cookie_value",
Domain: "example.com",
}),
)
if err != nil {
panic(err)
}
defer b.PutPage(page)
page.MustNavigate("https://example.com")
fmt.Println(page.MustInfo().Title)
}
```
### Blocking Image Loading
You can block image loading on a page by calling `b.BlockImageLoading(page)` to save bandwidth`:
```go
package main
import (
"fmt"
"github.com/simp-lee/browser"
)
func main() {
// Get a browser instance with default options
b, err := browser.GetBrowser()
if err != nil {
panic(err)
}
defer b.Close()
// Get a page instance from the browser
page, err := b.GetPage()
if err != nil {
panic(err)
}
defer b.PutPage(page)
// Block image loading on the page
if err := b.BlockImageLoading(page); err != nil {
panic(err)
}
page.MustNavigate("https://example.com")
fmt.Println(page.MustInfo().Title)
}
```
### Retrieving Cookies
You can retrieve cookies from a page instance using the `GetCookies` method::
```go
package main
import (
"fmt"
"github.com/simp-lee/browser"
)
func main() {
// Get a browser instance with default options
b, err := browser.GetBrowser()
if err != nil {
panic(err)
}
defer b.Close()
// Get a page instance from the browser
page, err := b.GetPage()
if err != nil {
panic(err)
}
defer b.PutPage(page)
// Navigate to a URL
page.MustNavigate("https://example.com")
// Get cookies from the page
cookies, err := b.GetCookies(page)
if err != nil {
panic(err)
}
// Print the cookies
for _, cookie := range cookies {
fmt.Printf("Cookie: %+v\n", cookie)
}
}
```