Skip to content
This repository was archived by the owner on Mar 16, 2024. It is now read-only.

Commit

Permalink
Added disclaimer to readme. (#10)
Browse files Browse the repository at this point in the history
Signed-off-by: Bill Maxwell <[email protected]>
  • Loading branch information
cloudnautique authored Jan 17, 2024
1 parent f209e25 commit c3c157e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,15 @@ MongoDB is a popular, open-source NoSQL database system that uses a document-ori
The Acornfile used to create a MongoDB based Acorn Service is available in the GitHub repository at [https://github.com/acorn-io/mongodb](https://github.com/acorn-io/mongodb). This service triggers the creation of a MongoDB database running in a single container which can easily be used by an application during development.

This MongoDB instance:

- is backed by a persistent volume
- uses a default (auto generated) password for the root user
- defines credentials for an additional user (with access limited to a given database)

The Acorn image of this service is hosted in GitHub container registry at [ghcr.io/acorn-io/mongodb](ghcr.io/acorn-io/mongodb)

Currently this Acorn has the following configuration options:

- *dbUser* of the additional user is automatically generated
- *dbName* is set to "mydb"

Expand All @@ -31,7 +33,7 @@ services: db: {

## Usage

The [examples folder](https://github.com/acorn-io/mongodb/tree/main/examples) contains a sample application using this Service. This app consists in a Python backend based on the FastAPI library, it displays a web page indicating the number of times the application was called, a counter is saved in the underlying MongoDB database and incremented with each request. The screenshot below shows the UI of the example application.
The [examples folder](https://github.com/acorn-io/mongodb/tree/main/examples) contains a sample application using this Service. This app consists in a Python backend based on the FastAPI library, it displays a web page indicating the number of times the application was called, a counter is saved in the underlying MongoDB database and incremented with each request. The screenshot below shows the UI of the example application.

![UI](./examples/images/ui.png)

Expand Down Expand Up @@ -102,4 +104,8 @@ Instead of managing your own Acorn installation, you can deploy this application

[![Run in Acorn](https://acorn.io/v1-ui/run/badge?image=ghcr.io+acorn-io+mongodb+examples:v%23.%23-%23)](https://acorn.io/run/ghcr.io/acorn-io/mongodb/examples:v%23.%23-%23)

An application running in the Sandbox will automatically shut down after 2 hours, but you can use the Acorn Pro plan to remove the time limit and gain additional functionalities.
An application running in the Sandbox will automatically shut down after 2 hours, but you can use the Acorn Pro plan to remove the time limit and gain additional functionalities.

## Disclaimer

Disclaimer: You agree all software products on this site, including Acorns or their contents, may contain projects and materials subject to intellectual property restrictions and/or Open-Source license (“Restricted Items”). Restricted Items found anywhere within this Acorn or on Acorn.io are provided “as-is” without warranty of any kind and are subject to their own Open-Source licenses and your compliance with such licenses are solely and exclusively your responsibility. [MongoDB](https://mongodb.com) is licensed under Server Side Public License (SSPL) v1 which can be found [here](https://github.com/mongodb/mongo/blob/master/LICENSE-Community.txt) and Acorn.io does not endorse and is not affiliated with MongoDB. By using Acorn.io you agree to our general disclaimer here: <https://www.acorn.io/terms-of-use>.

0 comments on commit c3c157e

Please sign in to comment.