Install Guide for Outline in Proxmox VE Helper-Scripts

[burgerga]

Caution

Pending merge #472, does not work yet! You can try burgerga's fork:

bash -c "$(wget -qLO - https://github.com/burgerga/ProxmoxVE/raw/add_outline_new/ct/outline.sh)"

but note that you're on your own for issues, as this is not supported/endorsed by the community-scripts community.

Important

For a functional Outline you need

• SSL: Either via reverse proxy (e.g., Nginx Proxy Manager) or setting a certificate manually (see the Outline SSL documentation). Here we assume you are using a reverse proxy.
• Authentication: You should configure one of the Authentication methods listed in the Outline Authentication documentation

This guide will explain how to fully install a Outline LXC using Proxmox VE Helper-Scripts.

1. Start by installing an Outline LXC using Proxmox VE Helper-Scripts:

   bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/vm/outline.sh)"

   (this will take some time)
2. After installation, enter the shell of your Outline LXC
3. Go to the directory where Outline is installed:

   cd /opt/outline

4. Edit /opt/outline/.env (e.g., with nano .env):
   • Add a value for URL, this should be a "fully qualified, publicly accessible URL" (although you can limit access to LAN only using your reverse proxy)
   • Add an authentication method, see the Outline Authentication documentation
   • (Optional) Add SMTP configuration to enable email (e.g. for notifications and invitation links).

Note

Have a look at /opt/outline/.env.sample for example configuration
NB Although it says "at least ONE OF EITHER Google, Slack, or Microsoft is required for a working installation" this is not the case, and any of the supported authentication methods should work.

5. Generate the database for outline with

yarn sequelize db:create

6. Restart Outline with

systemctl restart outline

7. If you pointed your URL to http://<OUTLINE_LXC_IP>:3000 in your reverse proxy, you should now be able to login by going to URL!

[Aloe-recite]

If I may, I would add that valid authentication methods are, as of now, Google Workspaces, MS Azure or Slack. It took me a few trials to understand that free Gmail is not valid and Github integration is not for OAuth but solely for merging PRs when writing your notes. Their documentation is not as clear as I'd like, and the mechanism is not exaclty straightforward. I ended up being stuck since I didn't have any of the mentioned providers, and ended up riesumating an old slack accunt tied to an old project, which is btw less than ideal and I'll probably activate a fresh ne account. Maintaining this additional information (likely to change in the future maybe) in Community-Scripts is less than ideal, but I would weigh it against the risk of many new issues/discussions from people not understaing how to set it up.
Just my 2c; sorry for butting in. BTW outline is working great with your beta script and is very light on resources, much more than anticipated, although AppFlowy is starting to tempt me with its AI integration... 😄

[burgerga]

Thanks for your note! The maintainers also had issues setting it up, so in the current state it will not be added as community-script.

I'm using OIDC, which is not too bad to set up as self-hosted service (e.g., using Authelia/Authentik/KeyCloak (probably also in that order)). Did you try https://docs.getoutline.com/s/hosting/doc/google-hOuvtCmTqQ for GMail? Because I added Google OAuth to Authentik using this approach, and that totally worked with a free GMail address (although Google's documentation is also terrible, so it took some tries).

Edit: Could work without Google Workspace: Just pick External instead of Internal (see for example the Authentik instructions: https://docs.goauthentik.io/docs/users-sources/sources/social-logins/google/)

[Aloe-recite]

Yes the page you linked says “Using Google as an OAuth provider is only supported if you are using Google Workspace” and unfortunately it’s true. I’m not using Authentik for the time being, we will see in the next future. It’s another thing to understand, setup and maintain for me but for Outline seems like the best bet. Setting up Slack was very easy too, it just took me a while to first try Google then GitHub all the while not realising it wasn’t supported. Unfortunately the selection of providers is too small but the it’s easy and you always have the OIDC route.