Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(tile-converter): update i3s-server manual #2552

Merged
merged 2 commits into from
Jul 18, 2023
Merged
Changes from all commits
Commits
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
48 changes: 46 additions & 2 deletions modules/tile-converter/src/i3s-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,56 @@ The server provides I3S Rest endpoints per specification https://github.com/Esri
### Serve 3DTiles to I3S converted dataset

- Convert data set from 3DTiles to I3S without `--slpk` option
- Serve output folder `I3sLayerPath="./data/BatchedTextured" DEBUG=i3s-server:* npx i3s-server`
- Serve output folder

Example for path `./data/BatchTextured/SceneServer/layers/0/...`:

#### Start the server

```bash
PORT=8080 HTTPS_PORT=4443 I3sLayerPath="./data" DEBUG=i3s-server:* npx i3s-server
```
#### Check the layer availability

The layer should be available on URLs:

- `http://localhost:8080/BatchTextured/SceneServer/layers/0/...`
- `https://localhost:4443/BatchTextured/SceneServer/layers/0/...`

#### Open in ArcGIS

`https://www.arcgis.com/home/webscene/viewer.html?url=http://localhost:8080/BatchTextured/SceneServer/layers/0/`

#### Open in I3S Explorer

`https://i3s.loaders.gl/viewer?tileset=http://localhost:8080/BatchTextured/SceneServer/layers/0`

### Serve SLPK

- Serve slpk file `I3sLayerPath="../datasets/Rancho_Mesh_mesh_v17_1.slpk" DEBUG=i3s-server:* npx i3s-server`
Example for path `../datasets/Rancho_Mesh_mesh_v17_1.slpk`:

#### Start the server

```bash
PORT=8080 HTTPS_PORT=4443 I3sLayerPath="../datasets/Rancho_Mesh_mesh_v17_1.slpk" DEBUG=i3s-server:* npx i3s-server
```
#### Check the layer availability

The layer should be available on URLs:

- `http://localhost:8080/SceneServer/layers/0/...`
- `https://localhost:4443/SceneServer/layers/0/...`

#### Open in ArcGIS

`https://www.arcgis.com/home/webscene/viewer.html?url=http://localhost:8080/SceneServer`

#### Open in I3S Explorer

`https://i3s.loaders.gl/viewer?tileset=http://localhost:8080/SceneServer/layers/0`

## ENV variables

- `I3sLayerPath` - path to converted data or SLPK file.
- `PORT` - HTTP port. Eg for `PORT = 8080 npx i3s-server` the server will work on host `http://localhost:8080/...`. Default value is `80`;
- `HTTPS_PORT` - HTTPS port. Eg for `PORT = 4443 npx i3s-server` the server will work on host `https://localhost:4443/...`. Default value is `443`