Skip to content

Commit e6eab22

Browse files
committed
update docs
1 parent dc47316 commit e6eab22

File tree

6 files changed

+11
-43
lines changed

6 files changed

+11
-43
lines changed

client/client_config_env.conf

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/develop/change-log.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Change Log
22

3+
### Version 3.0.1
4+
- ci: refactor spa-client command line distribution ci.
5+
- doc: rewrite some docs.
6+
37
### Version 3.0.0
48

59
- rewrite, remove warp, cors, ssl and openTelemetry.

docs/guide/getting-started.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ we also support serving multiple SPA in one domain:
7171

7272
## What's More
7373

74-
- a React example for
75-
spa-client: [js-app-example](https://github.com/fornetcode/spa-server/blob/master/example/js-app-example/README.md).
74+
- a React example for spa-client: [js-app-example](https://github.com/fornetcode/spa-server/blob/master/example/js-app-example/README.md).
7675
- spa-server [configuration](./spa-server-configuration.md) and its admin-server [http api](./spa-server-api.md)
7776
- spa-client [npm package](./spa-client-npm-package.md)
7877

docs/guide/spa-client-command-line.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Command Line
22

3-
We have provided command line in 1.x versions, but it seems no one need it. So we removed the binary release and docker
4-
release.
5-
6-
But you can build it from source.
3+
We provided command line client for Linux, Mac and Windows, you can download it at [Release Page](https://github.com/ForNetCode/spa-server/releases).
74

85
## Source Code
96

@@ -20,13 +17,10 @@ cd client
2017
cargo install --bin spa-client --path .
2118
```
2219

23-
## Overview
24-
25-
spa-client it a command line tool to help user upload files and release new SPA.
26-
2720
## Usage Example
2821

2922
There are some usage examples of `spa-client`, you also can get help by typing `spa-client -h`.
23+
The `config file path` could also set by environment variable: `SPA_CLIENT_CONFIG`.
3024

3125
```shell
3226
# upload static files to admin server, if not set $OPT_VERSION, will try to
@@ -49,20 +43,9 @@ the config file format is toml:
4943

5044
```toml
5145
[server]
52-
address = "http://127.0.0.1:9000"
53-
auth_token = "token"
46+
address = "http://127.0.0.1:9000" # SPA_SERVER_ADDRESS
47+
auth_token = "token" # SPA_SERVER_AUTH_TOKEN
5448
# [upload]
5549
## default value is:3
56-
# parallel = 3
57-
```
58-
59-
the config default file name is `client.conf`.
60-
61-
We also provide http api to interact with admin server, the following command is ok to upload and serve new version.
62-
63-
```shell
64-
# Uploading Files By scp and release
65-
scp $SPA_DIRECTORY \
66-
user@ip:$(curl "http://$ADMIN_SERVER/upload/position?domain=$DOMAIN" -H "Authorization: Bearer $TOKEN") &&\
67-
curl "http://$ADMIN_SERVER/update_version?domain=$DOMAIN" -H "Authorization: Bearer $TOKEN"
50+
# parallel = 3 # SPA_UPLOAD_PARALLEL
6851
```

docs/guide/spa-server-api.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The http api is described by `curl` command. You can run it in linux after varia
77

88
## Authorization
99

10-
It very simple, put `Token` to request http header: `Authorization: Bearer $TOKEN`
10+
It's very simple, put `Token` to request http header: `Authorization: Bearer $TOKEN`
1111

1212
## Simple API Without `spa-client`
1313

@@ -151,10 +151,4 @@ curl -X POST "$ADMIN_SERVER/files/revoke_version" \
151151
"domain":$DOMAIN,
152152
"version": $TARGET_VERSION
153153
}`
154-
```
155-
156-
### Get Cert version
157-
```shell
158-
curl -X POST "$ADMIN_SERVER/cert?domain=$DOMAIN_OPT" \
159-
- H "Authorization: Bearer $TOKEN"
160154
```

docs/guide/spa-server-release-package.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ The docker image is distributed at `Github Packages` as [`ghcr.io/fornetcode/spa
66
docker pull ghcr.io/fornetcode/spa-server:latest
77
```
88
## From Code
9-
There no plan to release binary package. You can `git clone` the code and build yourself.
10-
119
```shell
1210
git clone --recursive https://github.com/fornetcode/spa-server
1311
cargo build --package spa-server --release

0 commit comments

Comments
 (0)