Skip to content

Commit 18d62a6

Browse files
authored
Revise README for clarity and updated instructions
Updated README.md to clarify the purpose and installation steps for Trusted Server, including changes to Fastly setup instructions and CLI version requirements.
1 parent 74380bd commit 18d62a6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Trusted Server
22

3-
:information_source: Trusted Server is an open-source runtime and edge-orchestration layer for modern publishers - executing 3rd-party scripts and your entire ad-stack server-side, all under 1st-party control. Our goal is to move ad-related code execution and control from web browsers to publisher controlled, "trusted" edge-cloud infrastructure.
3+
:information_source: Trusted Server is an open-source, cloud based orchestration framework and runtime for publishers. It moves code execution and operations that traditionally occured in browsers (via 3rd party JS) to secure, zero-cold-start [WASM](https://webassembly.org) binaries running in [WASI](https://github.com/WebAssembly/WASI) supported environments. It importantly gives publishers benefits such as: dramatically increasing control over how and who they share their data with (while maintaining user-privacy compliance), increasing revenue from inventory inside cookie restricted or non-JS environments, ability to serve all assets under 1st party context, and provides secure cryptographic functions to ensure trust across the programmatic ad ecosystem.
44

55
Trusted Server is the new execution layer for the open-web - returning control of 1st party data, security, and overall user-experience back to publishers.
66

77
At this time, Trusted Server is designed to work with Fastly Compute. Follow these steps to configure Fastly Compute and deploy it.
88

9-
## Fastly
9+
## Getting Started: Edge-Cloud Support on Fastly
1010
- Create account at Fastly if you don’t have one - manage.fastly.com
1111
- Log in to the Fastly control panel.
1212
- Go to Account > API tokens > Personal tokens.
@@ -25,9 +25,9 @@ At this time, Trusted Server is designed to work with Fastly Compute. Follow the
2525
- IMPORTANT: when you enter the FQDN or IP ADDR information and click Add you need to enter a “Name” in the first field that will be referenced in your code so something like “my_ad_partner_1”
2626
-
2727

28-
:warning: Fastly gives you a test domain to play on but obviously you’re free to create a CNAME to your domain when you’re ready. Note that Fastly compute ONLY accepts client traffic from TLS
28+
:warning: With a dev account, Fastly gives you a test domain by default, but you’re also able to create a CNAME to your own domain when you’re ready, along with 2 free TLS certs (non-wildcard). Note that Fastly Compute ONLY accepts client traffic via TLS, though origins and backends can be non-TLS.
2929

30-
## Installation
30+
## CLI and OS Tools Installation
3131

3232
### Brew
3333

@@ -50,7 +50,7 @@ brew install fastly/tap/fastly
5050
fastly version
5151
```
5252

53-
:warning: fastly cli version should be at least v11.3.0
53+
:warning: fastly cli version should be at least v12.1.0
5454

5555
#### Create profile and follow interactive prompt for pasting your API Token created earlier:
5656
```sh
@@ -59,7 +59,7 @@ fastly profile create
5959

6060
### Rust
6161

62-
#### Install Rust with asdf
62+
#### Install Rust with asdf (our preference)
6363
```sh
6464
brew install asdf
6565
asdf plugin add rust
@@ -85,9 +85,9 @@ export PATH="${ASDF_DATA_DIR:-$HOME/.asdf}/shims:$PATH"
8585
See https://asdf-vm.com/guide/getting-started.html#_2-configure-asdf
8686

8787

88-
### Configure Build and
88+
### Clone Trusted Server and Configure Build
8989

90-
#### Clone Project
90+
#### Clone Project (assumes you have 'git' installed on your system)
9191
```sh
9292
git clone [email protected]:IABTechLab/trusted-server.git
9393
```
@@ -97,7 +97,7 @@ git clone [email protected]:IABTechLab/trusted-server.git
9797
:information_source: Note that you’ll have to edit the following files for your setup:
9898

9999
- fastly.toml (service ID, author, description)
100-
- trusted-server.toml (KV store ID names)
100+
- trusted-server.toml (KV store ID names - optional)
101101

102102
### Build
103103

0 commit comments

Comments
 (0)