mirror of
https://git.boykissers.com/pawkey/pawkey-sk.git
synced 2025-12-20 04:04:16 +00:00
docs: change branding Pawkey (#1)
- Change string instances from Sharkey to Pawkey - Change logos and art to Pawkey - Change repository URL where possible to our git repo - Puppy > Shonks - Change repo in compose_example.yml Co-Authored-By: Bluey Heeler <bluey@pawkey.dev>
This commit is contained in:
Leafus
@@ -1,5 +1,5 @@
|
||||
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
# Sharkey configuration
|
||||
# Pawkey configuration
|
||||
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
# ┌──────────────────────────────┐
|
||||
@@ -9,14 +9,14 @@
|
||||
# First of all, let me tell you a story that may possibly be
|
||||
# boring to you and possibly important to you.
|
||||
#
|
||||
# Sharkey is licensed under the AGPLv3 license. This license is
|
||||
# Pawkey is licensed under the AGPLv3 license. This license is
|
||||
# known to be often misunderstood. Please read the following
|
||||
# instructions carefully and select the appropriate option so
|
||||
# that you do not negligently cause a license violation.
|
||||
#
|
||||
|
||||
# --------
|
||||
# Option 1: If you host Sharkey AS-IS (without any changes to
|
||||
# Option 1: If you host Pawkey AS-IS (without any changes to
|
||||
# the source code. forks are not included).
|
||||
#
|
||||
# Step 1: Congratulations! You don't need to do anything.
|
||||
@@ -28,8 +28,8 @@
|
||||
# this repository. Strictly speaking, it doesn't have
|
||||
# to be a Git repository, but you'll probably use Git!
|
||||
#
|
||||
# Step 1: Build and run the Sharkey server first.
|
||||
# Step 2: Open <https://your.sharkey.example/admin/settings> in
|
||||
# Step 1: Build and run the Pawkey server first.
|
||||
# Step 2: Open <https://your.pawkey.example/admin/settings> in
|
||||
# your browser with the administrator account.
|
||||
# Step 3: Enter the URL of your Git repository in the
|
||||
# "Repository URL" field.
|
||||
@@ -37,7 +37,7 @@
|
||||
# --------
|
||||
# Option 3: If neither of the above applies to you.
|
||||
# (In this case, the source code should be published
|
||||
# on the Sharkey interface. IT IS NOT ENOUGH TO
|
||||
# on the Pawkey interface. IT IS NOT ENOUGH TO
|
||||
# DISCLOSE THE SOURCE CODE WHEN A USER REQUESTS IT BY
|
||||
# E-MAIL OR OTHER MEANS. If you are not satisfied
|
||||
# with this, it is recommended that you read the
|
||||
@@ -65,10 +65,10 @@
|
||||
# Password to initiate setting up admin account.
|
||||
# It will not be used after the initial setup is complete.
|
||||
#
|
||||
# Be sure to change this when you set up Sharkey via the Internet.
|
||||
# Be sure to change this when you set up Pawkey via the Internet.
|
||||
#
|
||||
# The provider of the service who sets up Sharkey on behalf of the customer should
|
||||
# set this value to something unique when generating the Sharkey config file,
|
||||
# The provider of the service who sets up Pawkey on behalf of the customer should
|
||||
# set this value to something unique when generating the Pawkey config file,
|
||||
# and provide it to the customer.
|
||||
#
|
||||
# setupPassword: example_password_please_change_this_or_you_will_get_hacked
|
||||
@@ -86,11 +86,11 @@ url: https://example.tld/
|
||||
#───┘ Port and TLS settings └───────────────────────────────────
|
||||
|
||||
#
|
||||
# Sharkey requires a reverse proxy to support HTTPS connections.
|
||||
# Pawkey requires a reverse proxy to support HTTPS connections.
|
||||
#
|
||||
# +----- https://example.tld/ ------------+
|
||||
# +------+ |+-------------+ +----------------+|
|
||||
# | User | ---> || Proxy (443) | ---> | Sharkey (3000) ||
|
||||
# | User | ---> || Proxy (443) | ---> | Pawkey (3000) ||
|
||||
# +------+ |+-------------+ +----------------+|
|
||||
# +---------------------------------------+
|
||||
#
|
||||
@@ -98,13 +98,13 @@ url: https://example.tld/
|
||||
# An encrypted connection with HTTPS is highly recommended
|
||||
# because tokens may be transferred in GET requests.
|
||||
|
||||
# The port that your Sharkey server should listen on.
|
||||
# The port that your Pawkey server should listen on.
|
||||
port: 3000
|
||||
# the address to bind to, defaults to "every address"
|
||||
# address: '0.0.0.0'
|
||||
|
||||
# You can also use UNIX domain socket.
|
||||
# socket: /path/to/sharkey.sock
|
||||
# socket: /path/to/pawkey.sock
|
||||
# chmodSocket: '777'
|
||||
|
||||
# ┌──────────────────────────┐
|
||||
@@ -115,10 +115,10 @@ db:
|
||||
port: 5432
|
||||
|
||||
# Database name
|
||||
db: sharkey
|
||||
db: pawkey
|
||||
|
||||
# Auth
|
||||
user: sharkey
|
||||
user: pawkey
|
||||
pass: example-misskey-pass
|
||||
|
||||
## Log a warning to the server console if any query takes longer than this to complete.
|
||||
@@ -361,8 +361,8 @@ proxyBypassHosts:
|
||||
#proxySmtp: socks5://127.0.0.1:1080 # use SOCKS5
|
||||
|
||||
# Path to the directory that uploaded media will be saved to
|
||||
# Defaults to a folder called "files" in the Sharkey directory
|
||||
#mediaDirectory: /var/lib/sharkey
|
||||
# Defaults to a folder called "files" in the Pawkey directory
|
||||
#mediaDirectory: /var/lib/pawkey
|
||||
|
||||
# Media Proxy
|
||||
# Reference Implementation: https://github.com/misskey-dev/media-proxy
|
||||
@@ -376,7 +376,7 @@ proxyRemoteFiles: true
|
||||
|
||||
# Movie Thumbnail Generation URL
|
||||
# There is no reference implementation.
|
||||
# For example, Sharkey will point to the following URL:
|
||||
# For example, Pawkey will point to the following URL:
|
||||
# https://example.com/thumbnail.webp?thumbnail=1&url=https%3A%2F%2Fstorage.example.com%2Fpath%2Fto%2Fvideo.mp4
|
||||
#videoThumbnailGenerator: https://example.com
|
||||
|
||||
@@ -410,7 +410,7 @@ attachLdSignatureForRelays: true
|
||||
# - 80
|
||||
# - 443
|
||||
|
||||
#customMOTD: ['Hello World', 'The sharks rule all', 'Shonks']
|
||||
#customMOTD: ['Hello World', 'Paws rule all', 'Paws']
|
||||
|
||||
# Disable automatic redirect for ActivityPub object lookup. (default: false)
|
||||
# This is a strong defense against potential impersonation attacks if the viewer instance has inadequate validation.
|
||||
@@ -464,10 +464,10 @@ attachLdSignatureForRelays: true
|
||||
# Transparently compress every websocket message on clients that support it.
|
||||
# Trades server CPU usage for reduced bandwidth usage and a faster frontend on the client.
|
||||
# If you're not using jemalloc, this may cause memory fragmentation and performance issues! (https://www.npmjs.com/package/ws#websocket-compression)
|
||||
# jemalloc is used by default in the Sharkey Docker image and may be set up manually otherwise: https://github.com/jemalloc/jemalloc/wiki/getting-started
|
||||
# jemalloc is used by default in the Pawkey Docker image and may be set up manually otherwise: https://github.com/jemalloc/jemalloc/wiki/getting-started
|
||||
websocketCompression: false
|
||||
|
||||
# Inject arbitrary HTML tags to customize Sharkey without having to fork it
|
||||
# Inject arbitrary HTML tags to customize Pawkey without having to fork it
|
||||
#customHtml:
|
||||
# head: |
|
||||
# <!-- The possibilities are limitless! -->
|
||||
|
||||
Reference in New Issue
Block a user