Skip to content

Commit

Permalink
deleted references to login repo
Browse files Browse the repository at this point in the history
deleted links to alternate repo that shows a login example
  • Loading branch information
codetricity committed Jun 10, 2024
1 parent 423ae6f commit e039caa
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 19 deletions.
20 changes: 9 additions & 11 deletions docs/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ your own server.

Contact Oppkey for login to our public cloud site to browse around.

## Deploy Your Own Public Site
## Example to Deploy on Vercel

If you wish to deploy your own site, refer to code on GitHub
repository [oppkey-ricoh360-viewer-demo-with-login](https://github.com/codetricity/oppkey-ricoh360-viewer-demo-with-login) for an example showing how to deploy to Vercel with basic authentication
login. The repo includes an example `vercel.json` file.
The site above is deployed on Vercel. If you want to see the code we use
for deployment as a reference, contact Oppkey for an example showing
how to deploy to Vercel and protect the site with basic authentication login.

For the example with login, the `secrets.env` needs to contain
With login, the `secrets.env` needs to contain
the `OPPKEY_VIEWER_PASSWORD` and `OPPKEY_VIEWER_USERNAME`
environmental variable.

Expand All @@ -31,17 +31,15 @@ PRIVATE_KEY="<long private key for the viewer>"
```

With the login example, the browser will open a sign in window.
even when running locally. You can change the credentials
You can change the credentials
in the `secrets.env` file for local testing.

![ login](images/cloud/login_credentials.png)

We have the reference for basic authentication if people want to share the demo they
build with their co-workers with a simple browser link. This repository example includes deployment configuration
The repository example includes deployment configuration
to Vercel, free plan. If you deploy to the public
Vercel cloud, you must set the [environmental
variables in Vercel](https://vercel.com/docs/projects/environment-variables). A free alternative to Vercel is
Netlify.
variables in Vercel](https://vercel.com/docs/projects/environment-variables). A free alternative to Vercel is Netlify.

### example vercel.json

Expand All @@ -61,4 +59,4 @@ Netlify.
}
]
}
```
```
6 changes: 3 additions & 3 deletions docs/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

Client ID, Client Secret, and Private Key are distributed by RICOH.

* Request access here: [ricoh360.com/contact](https://www.ricoh360.com/contact/)
* Request access here: <https://www.ricoh360.com/contact/>

## Oppkey

This site is run by Oppkey. If you have questions, please contact us here: [email protected]
This site is run by Oppkey. If you have questions, please contact us here: <[email protected]>

### Common Questions for Oppkey
### Help We Can Provide

* Username and password for public site - r360.oppget.com
* Access to Oppkey credentials, if authorized by RICOH
8 changes: 3 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ In addition, it is recommended you get a username and
password for the partner technical documentation.

## Installation and Setup
1. clone down repo [oppkey-ricoh-viewer-demo-basic](https://github.com/codetricity/oppkey-ricoh-viewer-demo-basic) (recommended) or [oppkey-ricoh360-viewer-demo-with-login](https://github.com/codetricity/oppkey-ricoh360-viewer-demo-with-login) (for cloud deploy with basic password auth)

1. clone down repo [oppkey-ricoh-viewer-demo-basic](https://github.com/codetricity/oppkey-ricoh-viewer-demo-basic)
1. Install [Node.js](https://nodejs.org/en) - Note that Oppkey uses [nvm](https://github.com/nvm-sh/nvm) to manage node versions. However, it may be simpler for you to install node straight from the node site.
1. In the root directory of the project, run `npm install`
1. create a `secrets.env` file in the project root. The file has this format:
Expand All @@ -22,7 +23,7 @@ password for the partner technical documentation.
CLIENT_ID=<Your unique client id from RICOH for the platform API>
CLIENT_SECRET=<client secret for your client id for the platform API>
PRIVATE_KEY="<long private key for the viewer>"
```
```

Full `secrets.env` used by Oppkey is available [here](https://github.com/codetricity/oppkey-ricoh-viewer-credentials/blob/main/README.md). The
private key, client id, and client secret are in a private GitHub repo. If you are a RICOH staff or partner and have authorization to use the Oppkey client id, private key, and client secret, then contact Oppkey and we will send you the file. Otherwise, please use your own credentials you received from RICOH.
Expand All @@ -32,7 +33,4 @@ private key, client id, and client secret are in a private GitHub repo. If you a
1. Run `npm run start`, the app should start locally on port 3000, `http://localhost:3000`
1. There are three buttons: community, documentation, viewer. Click on the viewer button.




![login screen](images/home/login_screen2.png)

0 comments on commit e039caa

Please sign in to comment.