Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

Remove "go install" README instructions #145

Merged
merged 2 commits into from
Sep 30, 2022
Merged

Remove "go install" README instructions #145

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf8f462
Remove "go install" README instructions
cretz Sep 29, 2022
069cd0e
Merge branch 'main' into readme-install-update
cretz Sep 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,7 @@ Features that align with this goal:

### Download and Start Temporal Server Locally

Build from source using [go install](https://golang.org/ref/mod#go-install):

> Note: Go 1.18 or greater is currently required.

```bash
go install github.com/temporalio/temporalite/cmd/temporalite@latest
```
Download and extract the [latest release](https://github.com/temporalio/temporalite/releases/latest) from [GitHub releases](https://github.com/temporalio/temporalite/releases).

Start Temporal server:

Expand Down Expand Up @@ -91,18 +85,14 @@ temporalite start --ephemeral

### Web UI

The `temporalite` binary can be compiled to omit static assets for installations that will never use the UI:

```bash
go install -tags headless github.com/temporalio/temporalite/cmd/temporalite@latest
```

The UI can also be disabled via a runtime flag:
By default the web UI is started with Temporalite. The UI can be disabled via a runtime flag:

```bash
temporalite start --headless
```

To build without static UI assets, use the `headless` build tag when running `go build`.

### Dynamic Config

Some advanced uses require Temporal dynamic configuration values which are usually set via a dynamic configuration file inside the Temporal configuration file. Alternatively, dynamic configuration values can be set via `--dynamic-config-value KEY=JSON_VALUE`.
Expand Down