Merge remote-tracking branch 'upstream/master' into dev-tbyte

.do/deploy.template.yaml

@@ -19,7 +19,7 @@ spec:
     - key: BUNDLE_WITHOUT
       scope: RUN_AND_BUILD_TIME
       type: GENERAL
-      value: 'development:test:private'
+      value: 'development:test'
     # Application Encryption Key
     - key: PWPUSH_MASTER_KEY
       scope: RUN_TIME

.erb-lint.yml

@@ -0,0 +1,9 @@
+---
+exclude:
+  - 'vendor/bundle/**/*'
+EnableDefaultLinters: true
+linters:
+  SpaceAroundErbTag:
+    enabled: true
+  ExtraNewline:
+    enabled: true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -29,9 +29,6 @@ Where are you running/using Password Pusher?
 - [ ] pwpush.com
 - [ ] Docker Image
   - [ ] pwpush
-  - [ ] pwpush-ephemeral
-  - [ ] pwpush-mysql
-  - [ ] pwpush-postgres
   - [ ] custom image
 - [ ] Heroku
 - [ ] Digital Ocean

.github/ISSUE_TEMPLATE/question.md

@@ -12,7 +12,7 @@ assignees:
 
 <!-- Regardless, if something isn't clearly documented or easy to understand - let me know! -->
 
-- [ ] I've searched the project's [`issues`](https://github.com/pglombardo/pwpush/issues?q=is%3Aissue).
+- [ ] I've searched the project's [`issues`](https://github.com/pglombardo/PasswordPusher/issues?q=is%3Aissue).
 - [ ] I've searched the project's [`discussions`](https://github.com/pglombardo/PasswordPusher/discussions).
 
 ## ❓ Question

.github/dependabot.yml

@@ -32,37 +32,7 @@ updates:
     open-pull-requests-limit: 50
 
   - package-ecosystem: "docker"
-    directory: "/containers/docker/pwpush"
-    schedule:
-      interval: "weekly"
-    allow:
-      - dependency-type: "all"
-    commit-message:
-      prefix: ":arrow_up:"
-    open-pull-requests-limit: 50
-
-  - package-ecosystem: "docker"
-    directory: "/containers/docker/pwpush-ephemeral"
-    schedule:
-      interval: "weekly"
-    allow:
-      - dependency-type: "all"
-    commit-message:
-      prefix: ":arrow_up:"
-    open-pull-requests-limit: 50
-
-  - package-ecosystem: "docker"
-    directory: "/containers/docker/pwpush-mysql"
-    schedule:
-      interval: "weekly"
-    allow:
-      - dependency-type: "all"
-    commit-message:
-      prefix: ":arrow_up:"
-    open-pull-requests-limit: 50
-
-  - package-ecosystem: "docker"
-    directory: "/containers/docker/pwpush-postgres"
+    directory: "/containers/docker"
     schedule:
       interval: "weekly"
     allow:

.github/release-drafter.yml

@@ -19,15 +19,33 @@ categories:
     labels: [dependencies]
 
 template: |
-  ## What’s Changed
+  ## :memo: What’s Changed
 
   $CHANGES
 
   ## :busts_in_silhouette: List of contributors
 
   $CONTRIBUTORS
 
-  ## Docker Images
+  ## :motor_boat: Docker Images
 
   Available on Docker Hub:
   https://hub.docker.com/r/pglombardo/pwpush
+
+  ## :running_man: Run This Version
+
+  ```bash
+  docker run -d -p 5100:5100 pglombardo/pwpush:$NEXT_PATCH_VERSION
+  ```
+
+  ..and go to `http://localhost:5100`
+
+  ## :link: Useful Links
+
+  * [Configuration](https://github.com/pglombardo/PasswordPusher/blob/master/Configuration.md) Documentation
+  * [API](https://pwpush.com/api) Documentation
+  * [Docker Hub](https://hub.docker.com/r/pglombardo/pwpush)
+  * [GitHub](https://github.com/pglombardo/PasswordPusher)
+  * [Website](https://pwpush.com)
+  * [Twitter](https://twitter.com/pwpush)
+  * [Newsletter](https://buttondown.email/pwpush)

.github/workflows/release-drafter.yml

@@ -11,6 +11,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5.25.0
+      - uses: release-drafter/release-drafter@v6.0.0
         env:
           GITHUB_TOKEN: ${{ secrets.TBYTE_TOKEN }}

.gitignore

@@ -22,6 +22,8 @@
 
 # Ignore the default SQLite database.
 *.sqlite3
+*.sqlite3-wal
+*.sqlite3-shm
 
 # Ignore all logfiles and tempfiles.
 /log/*.log
@@ -659,3 +661,7 @@ storage/
 !/app/assets/builds/.keep
 
 bin/*.rb
+
+/config/credentials/development.key
+/config/credentials/staging.key
+/config/credentials/production.key

.pre-commit-config.yaml

@@ -2,20 +2,31 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.2.0
+  rev: v3.4.0
   hooks:
     - id: trailing-whitespace
+      exclude: '\.enc$'
     - id: end-of-file-fixer
+      exclude: '\.enc$'
     - id: check-yaml
     - id: check-added-large-files
 
 - repo: local
   hooks:
-    - id: rubocop
-      name: Running rubocop
-      entry: rubocop
+    - id: erblint
+      name: ERBLint
+      entry: erblint
       language: system
-      pass_filenames: false
-      #args: ['-a']
-      always_run: true
-      stages: [pre-commit]
+      types: [html]
+      files: \.html\.erb$
+      pass_filenames: true
+
+- repo: local
+  hooks:
+    - id: standardrb
+      name: standardrb
+      entry: standardrb
+      language: system
+      types: [ruby]
+      files: \.rb$
+      pass_filenames: true

Configuration.md

@@ -88,6 +88,10 @@ Notes:
 | PWP__RELATIVE_ROOT | Runs the application in a subfolder.  e.g. With a value of `pwp` the front page will then be at `https://url/pwp` | `Not set` |
 | PWP__SHOW_VERSION | Show the version in the footer | `true` |
 | PWP__SHOW_GDPR_CONSENT_BANNER | Optionally enable or disable the GDPR cookie consent banner. | `true` |
+| PWP__TIMEZONE | Set the application wide timezone.  Use a valid timezone string (see note below). | `America/New_York` |
+| SECRET_KEY_BASE | A secret key that is used for various security-related features, including session cookie encryption and other cryptographic operations.  Use `/opt/PasswordPusher/bin/rails secret` to generate a random key string. [See the SECRET_KEY_BASE wiki page.](https://github.com/pglombardo/PasswordPusher/wiki/SECRET_KEY_BASE)| _Randomly Generated on boot_ |
+
+_Note_: The list of valid timezone strings can be found at [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
 
 ## Password Push Expiration Settings
 
@@ -188,6 +192,11 @@ This feature can store uploads on local disk (not valid for Docker containers),
 | PWP__ENABLE_FILE_PUSHES | On/Off switch for File Pushes. | `false` |
 | PWP__FILES__STORAGE | Chooses the storage area for uploaded files. | `local`, `amazon`, `google` or `microsoft` |
 | PWP__FILES__ENABLE_BLUR | Enables or disables the 'blur' effect when showing a text payload to the user. | `true` |
+| PWP__FILES__ENABLE_DELETABLE_PUSHES | Can passwords be deleted by viewers? When true, passwords will have a link to optionally delete the password being viewed | `false` |
+| PWP__FILES__DELETABLE_PUSHES_DEFAULT | When the above is `true`, this sets the default value for the option. | `true` |
+| PWP__FILES__ENABLE_RETRIEVAL_STEP | When `true`, adds an option to have a preliminary step to retrieve passwords.  | `true` |
+| PWP__FILES__RETRIEVAL_STEP_DEFAULT | Sets the default value for the retrieval step for newly created passwords. | `false` |
+| PWP__FILES__MAX_FILE_UPLOADS | Sets the maximum number of files that can be added to a single push. | `10` |
 
 ## File Push Expiration Settings
 
@@ -199,10 +208,6 @@ This feature can store uploads on local disk (not valid for Docker containers),
 | PWP__FILES__EXPIRE_AFTER_VIEWS_DEFAULT | Controls the "Expire After Views" default value in Password#new | `5` |
 | PWP__FILES__EXPIRE_AFTER_VIEWS_MIN | Controls the "Expire After Views" minimum value in Password#new | `1` |
 | PWP__FILES__EXPIRE_AFTER_VIEWS_MAX | Controls the "Expire After Views" maximum value in Password#new | `100` |
-| PWP__FILES__ENABLE_DELETABLE_PUSHES | Can passwords be deleted by viewers? When true, passwords will have a link to optionally delete the password being viewed | `false` |
-| PWP__FILES__DELETABLE_PUSHES_DEFAULT | When the above is `true`, this sets the default value for the option. | `true` |
-| PWP__FILES__ENABLE_RETRIEVAL_STEP | When `true`, adds an option to have a preliminary step to retrieve passwords.  | `true` |
-| PWP__FILES__RETRIEVAL_STEP_DEFAULT | Sets the default value for the retrieval step for newly created passwords. | `false` |
 
 ## Local Storage
 
@@ -384,14 +389,32 @@ volumes:
   - /var/lib/pwpush/logos:/opt/PasswordPusher/public/logos:r
 ```
 
-See [here](https://github.com/pglombardo/PasswordPusher/blob/master/containers/docker/pwpush/docker-compose-postgres.yml) for a larger Docker Compose explanation.
+See [here](https://github.com/pglombardo/PasswordPusher/blob/master/containers/docker/docker-compose-postgres.yml) for a larger Docker Compose explanation.
 
 With this setup, you can then set your `LOGO` environment variables (or `settings.yml` options) to:
 
 ```
 PWP__BRAND__LIGHT_LOGO=/logos/mylogo.png
 ```
 
+## Favicons
+
+The application favicons can also be changed to your own assets.
+
+These favicons are used in browser tabs, in bookmarks and in browser history.
+
+At a bare minimum, make sure to set at least `icon_57x57` and `icon_96x96`.  Without these two, things are guaranteed
+to not work.
+
+To create favicons you can use an icon generator such as:
+
+https://www.favicongenerator.com
+or
+https://www.favicon-generator.org
+
+See the [Rebranding:Favicon section](https://github.com/pglombardo/PasswordPusher/blob/master/config/settings.yml#L623) of the `settings.yml` file for more specifics.
+
+
 ## See Also
 
 * the `brand` section of [settings.yml](https://github.com/pglombardo/PasswordPusher/blob/master/config/settings.yml) for more details, examples and description.