Skip to content

Commit

Permalink
docs: 📝 update README with new features, instructions to disable sign…
Browse files Browse the repository at this point in the history
…-up and add screenshots
  • Loading branch information
Dan6erbond committed May 8, 2023
1 parent c64ee86 commit 62c61ab
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ A selfhosted image and video uploading platform that uses Next.js and PocketBase

![Screenshot](./assets/screenshots/post.png)

More screenshots can be found in the [screenshots](./assets/screenshots/) directory.

## Features

- Sign-Up with Username/Email and Password
- Full-Page Drag/Drop and Paste Support
- Share Post URLs, Mark Post Public/NSFW
- Generate OpenGraph and Twitter Metadata for Social Media Embeds
- Supports WhatsApp, Discord, Twitter, Facebook and More
- PocketBase Backend with Support for the Following:
- Username/Email Sign-up and Login
- OIDC Authentication
- SMTP Mail Server for Verification Mails (WIP)
- S3 Configuration for File Storage
Expand Down Expand Up @@ -96,10 +99,16 @@ The default file size limit is about 5MB and can be changed in the PocketBase UI

### Authentication

#### Providers

Share Me loads the configured PocketBase authentication providers. Head to your PocketBase admin dashboard, go to Settings > Auth providers and configure the ones you want to use.

#### Disabling Username/Password

To disable username/password and email/password login if you only want to allow access via SSO, go to Collections > users > Settings (cog icon) > Options and disable/enable the methods you want.

If you only want to disable sign-up, remove the "create" API rules to only allow admins to create new users. You can set the `SIGNUP_ENABLED` environment variable in the frontend to disable the sign-up page and remove links to it.

## Contributions

🚧 WIP
Expand Down
Binary file added assets/screenshots/discord_embed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshots/dropzone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshots/user_posts_drawer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 62c61ab

Please sign in to comment.