Forgejo
Forgejo
Since v0.41.0
Introduction
The Testcontainers module for Forgejo, a self-hosted Git forge. Forgejo is a community-driven fork of Gitea, providing a lightweight code hosting solution.
Adding this module to your project dependencies
Please run the following command to add the Forgejo module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/forgejoUsage example
Creating a Forgejo container
ctx := context.Background()
forgejoContainer, err := forgejo.Run(ctx, "codeberg.org/forgejo/forgejo:11")
defer func() {
if err := testcontainers.TerminateContainer(forgejoContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}Module Reference
Run function
- Since v0.41.0
The Forgejo module exposes one entrypoint function to create the Forgejo container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)context.Context, the Go context.string, the Docker image to use.testcontainers.ContainerCustomizer, a variadic argument for passing options.
Image
Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "codeberg.org/forgejo/forgejo:11").
Container Options
When starting the Forgejo container, you can pass options in a variadic way to configure it.
Admin Credentials
- Since v0.41.0
Use WithAdminCredentials(username, password, email) to set the admin user credentials. An admin user is automatically created when the container starts. Default credentials are forgejo-admin / forgejo-admin.
Configuration via Environment
- Since v0.41.0
Use WithConfig(section, key, value) to set Forgejo configuration values using the FORGEJO__section__key environment variable format. See the Forgejo Configuration Cheat Sheet for available options.
The following options are exposed by the testcontainers package.
Basic Options
WithExposedPortsSince v0.37.0WithEnvSince v0.29.0WithWaitStrategySince v0.20.0WithAdditionalWaitStrategySince v0.38.0WithWaitStrategyAndDeadlineSince v0.20.0WithAdditionalWaitStrategyAndDeadlineSince v0.38.0WithEntrypointSince v0.37.0WithEntrypointArgsSince v0.37.0WithCmdSince v0.37.0WithCmdArgsSince v0.37.0WithLabelsSince v0.37.0
Lifecycle Options
WithLifecycleHooksSince v0.38.0WithAdditionalLifecycleHooksSince v0.38.0WithStartupCommandSince v0.25.0WithAfterReadyCommandSince v0.28.0
Files & Mounts Options
WithFilesSince v0.37.0WithMountsSince v0.37.0WithTmpfsSince v0.37.0WithImageMountSince v0.37.0
Build Options
WithDockerfileSince v0.37.0
Logging Options
WithLogConsumersSince v0.28.0WithLogConsumerConfigSince v0.38.0WithLoggerSince v0.29.0
Image Options
WithAlwaysPullSince v0.38.0WithImageSubstitutorsSince v0.26.0WithImagePlatformSince v0.38.0
Networking Options
WithNetworkSince v0.27.0WithNetworkByNameSince v0.38.0WithBridgeNetworkSince v0.38.0WithNewNetworkSince v0.27.0
Advanced Options
WithHostPortAccessSince v0.31.0WithConfigModifierSince v0.20.0 · Chainable since mainWithHostConfigModifierSince v0.20.0 · Chainable since mainWithEndpointSettingsModifierSince v0.20.0 · Chainable since mainCustomizeRequestSince v0.20.0WithNameSince v0.38.0WithNoStartSince v0.38.0WithProviderSince v0.39.0
Experimental Options
WithReuseByNameSince v0.37.0
Container Methods
The Forgejo container exposes the following methods:
ConnectionString
- Since v0.41.0
The ConnectionString method returns the HTTP URL for the Forgejo instance (e.g. http://localhost:12345).
SSHConnectionString
- Since v0.41.0
The SSHConnectionString method returns the SSH endpoint for Git operations.
评论
登录后参与评论
KnowForge