Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/userguide/phame.diviner
@title Phame User Guide | @title Phame User Guide | ||||
@group userguide | @group userguide | ||||
Phame is a blogging platform. | Phame is a blogging platform. | ||||
Overview | Overview | ||||
======== | ======== | ||||
Phame is a simple platform for writing blogs and blog posts. Content published | Phame is a simple platform for writing blogs and blog posts. Content published | ||||
through Phame is integrated with other Phabricator applications (like Feed, | through Phame is integrated with other Phorge applications (like Feed, | ||||
Herald and Dashboards). | Herald and Dashboards). | ||||
You can use Phame to write and publish posts on any topic. You might use it to | You can use Phame to write and publish posts on any topic. You might use it to | ||||
make announcements, hold discussions, or provide progress updates about a | make announcements, hold discussions, or provide progress updates about a | ||||
project. | project. | ||||
In the upstream, we use several Phame blogs to discuss changes to Phabricator, | In the upstream, we use several Phame blogs to discuss changes to Phorge, | ||||
make company announcements, photograph food, and provide visionary thought | make company announcements, photograph food, and provide visionary thought | ||||
leadership. | leadership. | ||||
Blogs | Blogs | ||||
===== | ===== | ||||
To get started with Phame, create a blog. Blogs can be personal or edited | To get started with Phame, create a blog. Blogs can be personal or edited | ||||
Show All 30 Lines | |||||
After publishing a post, it will appear on the blog and on the Phame home page | After publishing a post, it will appear on the blog and on the Phame home page | ||||
for all users who can see it. | for all users who can see it. | ||||
Using Phame With Other Applications | Using Phame With Other Applications | ||||
=================================== | =================================== | ||||
Phame integrates with other Phabricator applications, so you can do a few | Phame integrates with other Phorge applications, so you can do a few | ||||
interesting things: | interesting things: | ||||
**Dashboards**: You can create a dashboard panel which shows posts on a | **Dashboards**: You can create a dashboard panel which shows posts on a | ||||
particular blog, then put the panel on the homepage or a custom dashboard. | particular blog, then put the panel on the homepage or a custom dashboard. | ||||
This is an easy way to create a list of recent announcements. | This is an easy way to create a list of recent announcements. | ||||
**Herald**: You can use Herald rules to make sure you get notified whenever | **Herald**: You can use Herald rules to make sure you get notified whenever | ||||
Show All 12 Lines | |||||
WARNING: This feature is still a prototype and has some known issues. | WARNING: This feature is still a prototype and has some known issues. | ||||
You can host a Phame blog on an external domain, like `blog.mycompany.com`. The | You can host a Phame blog on an external domain, like `blog.mycompany.com`. The | ||||
Phacility corporate blog is an example of an external Phame blog: | Phacility corporate blog is an example of an external Phame blog: | ||||
> https://blog.phacility.com/ | > https://blog.phacility.com/ | ||||
External blogs are public (they do not require login) and are only supported if | External blogs are public (they do not require login) and are only supported if | ||||
your Phabricator install is also public. You can make an install public by | your Phorge install is also public. You can make an install public by | ||||
adjusting `policy.allow-public` in Config, but make sure you understand the | adjusting `policy.allow-public` in Config, but make sure you understand the | ||||
effects of adjusting this setting before touching it. | effects of adjusting this setting before touching it. | ||||
Once you've made your install public, configure the blog that you want to host | Once you've made your install public, configure the blog that you want to host | ||||
like this: | like this: | ||||
- **View Policy**: Set the "View Policy" for the blog to "Public". Blogs must | - **View Policy**: Set the "View Policy" for the blog to "Public". Blogs must | ||||
have a public view policy to be served from an external domain. | have a public view policy to be served from an external domain. | ||||
- **Full Domain URI**: Set this to the full URI of your external domain, | - **Full Domain URI**: Set this to the full URI of your external domain, | ||||
like `https://blog.mycompany.com/`. When users visit this URI, Phabricator | like `https://blog.mycompany.com/`. When users visit this URI, Phorge | ||||
will serve the blog to them. | will serve the blog to them. | ||||
To configure the blog's navigation breadcrumbs so that it links back to the | To configure the blog's navigation breadcrumbs so that it links back to the | ||||
right parent site, set these options: | right parent site, set these options: | ||||
- **Parent Site Name**: Put the parent site name here (like "MyCompany"). | - **Parent Site Name**: Put the parent site name here (like "MyCompany"). | ||||
- **Parent Site URI**: Put the parent site URI here (like | - **Parent Site URI**: Put the parent site URI here (like | ||||
`https://www.mycompany.com`). | `https://www.mycompany.com`). | ||||
Configuring these options will add a new breadcrumb to the navigation to let | Configuring these options will add a new breadcrumb to the navigation to let | ||||
users return to the blog's parent site. It will look something like this: | users return to the blog's parent site. It will look something like this: | ||||
- {nav My Company > Blog Name} | - {nav My Company > Blog Name} | ||||
Finally, configure DNS for `blog.mycompany.com` to point at Phabricator. | Finally, configure DNS for `blog.mycompany.com` to point at Phorge. | ||||
If everything is set up properly, visiting `blog.mycompany.com` should now | If everything is set up properly, visiting `blog.mycompany.com` should now | ||||
serve your blog. | serve your blog. |
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0