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:
@@ -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,14 +86,14 @@
|
||||
#───┘ Port and TLS settings └───────────────────────────────────
|
||||
|
||||
#
|
||||
# Sharkey supports two deployment options for public.
|
||||
# Pawkey supports two deployment options for public.
|
||||
#
|
||||
|
||||
# Option 1: With Reverse Proxy
|
||||
#
|
||||
# +----- https://example.tld/ ------------+
|
||||
# +------+ |+-------------+ +----------------+|
|
||||
# | User | ---> || Proxy (443) | ---> | Sharkey (3000) ||
|
||||
# | User | ---> || Proxy (443) | ---> | Pawkey (3000) ||
|
||||
# +------+ |+-------------+ +----------------+|
|
||||
# +---------------------------------------+
|
||||
#
|
||||
@@ -104,15 +104,15 @@
|
||||
#
|
||||
# +- https://example.tld/ -+
|
||||
# +------+ | +---------------+ |
|
||||
# | User | ---> | | Sharkey (443) | |
|
||||
# | User | ---> | | Pawkey (443) | |
|
||||
# +------+ | +---------------+ |
|
||||
# +------------------------+
|
||||
#
|
||||
# You need to run Sharkey as root.
|
||||
# You need to run Pawkey as root.
|
||||
# You need to set Certificate in 'https' section.
|
||||
|
||||
# To use option 1, uncomment below line.
|
||||
port: 3000 # A port that your Sharkey server should listen.
|
||||
port: 3000 # A port that your Pawkey server should listen.
|
||||
|
||||
# To use option 2, uncomment below lines.
|
||||
#port: 443
|
||||
@@ -319,7 +319,7 @@ checkActivityPubGetSignature: false
|
||||
# '127.0.0.1/32'
|
||||
#]
|
||||
|
||||
#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.
|
||||
|
||||
Reference in New Issue
Block a user