Skip to content

first-upload-dc.adoc

Latest commit

 

History

History
75 lines (46 loc) · 2.07 KB

first-upload-dc.adoc

File metadata and controls

75 lines (46 loc) · 2.07 KB
Raw

First upload to Confluence Data Center / Server

In this tutorial you will publish your first Markdown page to Confluence Data Center or Server using text2confl.

What you need before starting:

  • A Confluence Data Center or Server instance

  • Permission to create pages in at least one space

  • A terminal on macOS, Linux, or WSL

Step 2 - Get a personal access token

In Confluence, go to your profile → Personal Access Tokens and create a new token. Save it - you won’t be able to see it again.

See the official guide if you can’t find the setting.

Step 4 - Create a configuration file

First, create a page in your Confluence space that will act as the parent for your uploaded docs (e.g. title it "My Docs"). Note the exact title - you will use it in the config.

Then create .text2confl.yml in your docs directory:

server: https://confluence.yourcompany.org
space: MYSPACE
default-parent: My Docs
docs-location: https://github.com/yourorg/yourrepo/tree/main/my-docs/

Replace:

  • https://confluence.yourcompany.org with your Confluence server URL

  • MYSPACE with the space key where you want to publish (visible in the Confluence space URL, e.g. https://confluence.yourcompany.org/display/MYSPACE/…​)

  • My Docs with the title of the parent page you created

  • docs-location with the URL where your docs live in version control (used to add a source link to each published page)

Step 6 - Upload to Confluence

$T2C upload --docs . \
  --access-token YOUR_PERSONAL_ACCESS_TOKEN

text2confl will scan the directory, convert hello-world.md to Confluence Storage Format, and publish it as a new page in your space.

Tip
 Add --dry to preview what would be uploaded without making any changes to Confluence.