diff --git a/docs/how-to/access--the-rails-console.md b/docs/how-to/access--the-rails-console.md index 3d14a919..a3900990 100644 --- a/docs/how-to/access--the-rails-console.md +++ b/docs/how-to/access--the-rails-console.md @@ -26,4 +26,4 @@ If the output of the last command contains something similar to this: Loading production environment (Rails 7.0.5.1) irb(main):001:0> ``` -Congratulations, you have accessed the rails console. +Congratulations, you have accessed the rails console. \ No newline at end of file diff --git a/docs/how-to/backup-and-restore.md b/docs/how-to/backup-and-restore.md index 63c60973..e710d1fb 100644 --- a/docs/how-to/backup-and-restore.md +++ b/docs/how-to/backup-and-restore.md @@ -54,4 +54,4 @@ but it is not explained in this How-to. If the S3 bucket used in the restored Discourse is not the same bucket as the original one, extra steps must be done, see [moving from one S3 bucket to another](https://meta.discourse.org/t/moving-from-one-s3-bucket-to-another/184779) for more information. You can run the remap command with: `juju ssh --container discourse discourse-k8s/0 pebble exec --context=discourse --user=_daemon_ -w=/srv/discourse/app/ -- bundle exec /srv/discourse/app/script/discourse backup` -and rake tasks with a command like: `juju ssh --container discourse discourse-k8s/0 pebble exec --context=discourse --user=_daemon_ -w=/srv/discourse/app/ -- bundle exec rake posts:rebake`. +and rake tasks with a command like: `juju ssh --container discourse discourse-k8s/0 pebble exec --context=discourse --user=_daemon_ -w=/srv/discourse/app/ -- bundle exec rake posts:rebake`. \ No newline at end of file diff --git a/docs/how-to/configure-container.md b/docs/how-to/configure-container.md index a9df0587..f01012a7 100644 --- a/docs/how-to/configure-container.md +++ b/docs/how-to/configure-container.md @@ -6,4 +6,4 @@ This charm exposes several configurations to tweak the behaviour of Discourse. T * The developer mails can be set through [developer_emails](https://charmhub.io/discourse-k8s/configure#developer_emails) * Throttle level protections provided by Discourse can be changed via [throttle_level](https://charmhub.io/discourse-k8s/configure#throttle_level) -For a comprehensive list of configuration options check the [configuration reference](https://charmhub.io/discourse-k8s/configure). +For a comprehensive list of configuration options check the [configuration reference](https://charmhub.io/discourse-k8s/configure). \ No newline at end of file diff --git a/docs/how-to/configure-s3.md b/docs/how-to/configure-s3.md index 17c7d78e..99b1f5f3 100644 --- a/docs/how-to/configure-s3.md +++ b/docs/how-to/configure-s3.md @@ -16,4 +16,4 @@ To enable S3 to perform backups, you'll need to specify also `s3_backup_bucket`. It is also possible to configure the S3 bucket to act as a content delivery network (CDN) serving the static content directly from the bucket; for that, set `s3_cdn_url`. If you wish to modify the CORS set up, you can do so by changing `s3_install_cors_rule`. -For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure). +For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure). \ No newline at end of file diff --git a/docs/how-to/configure-saml.md b/docs/how-to/configure-saml.md index 4158f354..29f6f8f2 100644 --- a/docs/how-to/configure-saml.md +++ b/docs/how-to/configure-saml.md @@ -13,4 +13,4 @@ juju config saml-integrator entity_id=https://login.staging.ubuntu.com juju integrate discourse-k8s saml-integrator ``` -For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure). +For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure). \ No newline at end of file diff --git a/docs/how-to/contribute.md b/docs/how-to/contribute.md index 500e20d2..41bea7af 100644 --- a/docs/how-to/contribute.md +++ b/docs/how-to/contribute.md @@ -100,4 +100,4 @@ juju deploy ./discourse-k8s_ubuntu-20.04-amd64.charm \ ## Canonical Contributor Agreement -Canonical welcomes contributions to the Discourse Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution. +Canonical welcomes contributions to the Discourse Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 499371e4..9239a9c5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -53,8 +53,8 @@ fixes and constructive feedback. 1. [Reference](reference) 1. [Actions](reference/actions.md) 1. [Configurations](reference/configurations.md) + 1. [External Access](reference/external-access.md) 1. [Integrations](reference/integrations.md) 1. [Plugins](reference/plugins.md) - 1. [External Access](reference/external-access.md) 1. [Explanation](explanation) - 1. [Charm architecture](explanation/charm-architecture.md) + 1. [Charm architecture](explanation/charm-architecture.md) \ No newline at end of file diff --git a/docs/reference/actions.md b/docs/reference/actions.md index de15a802..d6dd2bb6 100644 --- a/docs/reference/actions.md +++ b/docs/reference/actions.md @@ -2,4 +2,4 @@ See [Actions](https://charmhub.io/discourse-k8s/actions). -> Read more about actions in the Juju docs: [Action](https://juju.is/docs/juju/action) +> Read more about actions in the Juju docs: [Action](https://juju.is/docs/juju/action) \ No newline at end of file diff --git a/docs/reference/configurations.md b/docs/reference/configurations.md index 4c19c6ab..e25aa557 100644 --- a/docs/reference/configurations.md +++ b/docs/reference/configurations.md @@ -2,4 +2,4 @@ See [Configurations](https://charmhub.io/discourse-k8s/configure). -> Read more about configurations in the Juju docs: [Configuration](https://juju.is/docs/juju/configuration) +> Read more about configurations in the Juju docs: [Configuration](https://juju.is/docs/juju/configuration) \ No newline at end of file diff --git a/docs/reference/external-access.md b/docs/reference/external-access.md deleted file mode 100644 index cec7d8ed..00000000 --- a/docs/reference/external-access.md +++ /dev/null @@ -1,16 +0,0 @@ -# External access required by the Charm - -Depending on the configuration of the charm, the following external accesses are needed: - - Access to the PostgreSQL database (mandatory). - - Access to the S3 server is S3 is configured in the charm. - - Access to http://github.com to download Promtail if the logging interface is used in the charm. - -If the option "external system avatars enabled" is enabled in the admin, access -to https://avatars.discourse.org is necessary. - -Besides that, other services, like link previews and installing themes from a git repository -may need access to external sites to work, so allowing internet access to the Discourse instance is -recommended. In restricted environments, the `model-config` options `juju-http-proxy`, `juju-https-proxy` -and `juju-no-proxy` can be used to set up a proxy for Discourse, -see [Using proxies with Charmed Kubernetes](https://ubuntu.com/kubernetes/docs/proxies) for -more information. \ No newline at end of file diff --git a/docs/reference/integrations.md b/docs/reference/integrations.md index 61bff77a..cd9b1f40 100644 --- a/docs/reference/integrations.md +++ b/docs/reference/integrations.md @@ -80,4 +80,4 @@ Discourse uses Redis to run background tasks (with Sidekiq) and keep the applica Redis integrate commands: ``` juju integrate discourse-k8s redis-k8s -``` +``` \ No newline at end of file diff --git a/docs/tutorial.md b/docs/tutorial.md index 3acb372f..c651c30d 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -151,4 +151,4 @@ If you used Multipass, to remove the Multipass instance you created for this tut ``` multipass delete --purge my-juju-vm ``` -Finally, remove the `127.0.0.1 discourse-k8s` line from the `/etc/hosts` file. +Finally, remove the `127.0.0.1 discourse-k8s` line from the `/etc/hosts` file. \ No newline at end of file