Skip to content

Commit

Permalink
PR(ACP-DOCS): Warning / Caveat Section In README
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzadlone committed Apr 2, 2024
1 parent 3034286 commit 6a7d19b
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,29 @@ defradb start --tls --pubkeypath ~/path-to-pubkey.key --privkeypath ~/path-to-pr
## Access Control System
Read more about the access control [here](./acp/ACP.md).

### Warning / Caveats
The following features currently don't work with ACP, they are being actively worked on.
- [P2P: Adding a replicator with permissioned collection](https://github.com/sourcenetwork/defradb/issues/2366)
- [P2P: Subscription to a permissioned collection](https://github.com/sourcenetwork/defradb/issues/2366)
- [Adding Secondary Indexes](https://github.com/sourcenetwork/defradb/issues/2365)
- [Backing/Restoring Private Documents](https://github.com/sourcenetwork/defradb/issues/2430)

The following features may have undefined/unstable behavior until they are properly tested:
- [Views](https://github.com/sourcenetwork/defradb/issues/2018)
- [Average Operations](https://github.com/sourcenetwork/defradb/issues/2475)
- [Count Operations](https://github.com/sourcenetwork/defradb/issues/2474)
- [Group Operations](https://github.com/sourcenetwork/defradb/issues/2473)
- [Limit Operations](https://github.com/sourcenetwork/defradb/issues/2472)
- [Order Operations](https://github.com/sourcenetwork/defradb/issues/2471)
- [Sum Operations](https://github.com/sourcenetwork/defradb/issues/2470)
- [Dag/Commit Operations](https://github.com/sourcenetwork/defradb/issues/2469)
- [Delete With Filter Operations](https://github.com/sourcenetwork/defradb/issues/2468)
- [Update With Filter Operations](https://github.com/sourcenetwork/defradb/issues/2467)
- [Type Join Many Operations](https://github.com/sourcenetwork/defradb/issues/2466)
- [Type Join One Operations](https://github.com/sourcenetwork/defradb/issues/2466)
- [Parallel Operations](https://github.com/sourcenetwork/defradb/issues/2465)
- [Execute Explain](https://github.com/sourcenetwork/defradb/issues/2464)

## Supporting CORS

When accessing DefraDB through a frontend interface, you may be confronted with a CORS error. That is because, by default, DefraDB will not have any allowed origins set. To specify which origins should be allowed to access your DefraDB endpoint, you can specify them when starting the database:
Expand Down

0 comments on commit 6a7d19b

Please sign in to comment.