Giter Club home page Giter Club logo

docs's Introduction

πŸ“š Railway Documentation

Visit docs.railway.app

og

πŸ’‘ About

This is the place where all the documentation about Railway is hosted. Contributions are welcome! Change the markdown, make a pull request, and we'll merge it! Deploys will happen automagically cause the docs are hosted on Railway

πŸ§‘β€πŸ”¬ Contributing

This is a NextJS project.

Develop with

npm run dev
# or
yarn dev

Open localhost:3001 to see the result

docs's People

Contributors

aleksrutins avatar brody192 avatar char8 avatar christianivicevic avatar cobaltt7 avatar coffee-cup avatar dbanys avatar farazpatankar avatar gimenete avatar gschier avatar half0wl avatar ideabrian avatar jakecooper avatar korabi-dev avatar luni-moon avatar maxdeviant avatar melissa-hale avatar milo123459 avatar mootpt avatar ndneighbor avatar nebulatgs avatar nonstopflights avatar pierre-borckmans avatar rawleyfowler avatar samridht23 avatar sasukeuchiha912 avatar soggycactus avatar symmetricalboy avatar ve-varun-sharma avatar zuchka avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Nixpacks option can't be selected once Docerfile is detected in repo

Hi, so I have a Dockerfile in my repo but I dont want to use it as the template for building the deployment image, however the select buildtool option disappears as soon as the Dockerfile is detected in the repo. I also dont want to have to rename the Dockerfile so it doesn't get detected by default. Is there any way to re-enable Nixpacks for instance in this case.
image

deploy/builds lang specific links are broken when following in app doc links

Was trying to learn more about golang build, but the docs don't work for any of the languages, instead the page is 404-ing.

Offending page https://docs.railway.app//deploy/builds I got there by clicking this docs link:
image

image
Link for go:https://docs.railway.app//deploy/go
But I get redirected to https://docs.railway.app/go

I think something is wrong with the double forward slash // that I got from the link. Also is weird that docs don't accept that url route either.

Added Instructions for Migrating from Vercle to Railway.

Migrated from Vercel to Railway.

Step 1: Choose a New Hosting Provider - Railway

Railway is a great choice for deployment due to its simplicity and flexibility. Let's proceed with setting up an account and preparing for migration. Migrating your app from Vercel to Railway is very simple. All you need to do is create a project in Railway, push your code, and migrate your envionment variables. This guide will step you through the process of migrating a simple web service, using the Railway CLI.

Step 2: Set Up Railway CLI

Make sure you have the Railway CLI installed. If not, you can install it using npm:

npm install -g railway

Step 3: Login to Railway

Log in to your Railway account using the CLI:

railway login

Step 4: Initialize Your Project on Railway

Navigate to your project directory and initialize it with Railway:

cd your-project-directory
railway init

Step 5: Create a New Project on Railway

You can create a new project on Railway directly from the CLI:

 railway up

Step 6: Set Up Environment Variables

If your Vercel project uses environment variables, you'll need to set them up in Railway. You can add environment variables using the Railway Dashboard or CLI:

railway variables set VARIABLE_NAME=value

Step 8: Deploy Your Project

To deploy your project to Railway, use the following command:

railway up

Step 8: Generate a Custom Domain

Railway allows you to easily set up custom domains for your projects. Follow these steps to generate and configure a custom domain for your Railway-hosted application:

  1. Open Railway Dashboard:

  2. Navigate to the project you want to deploy:

    • In your project dashboard, click on the "Settings" tab and then go to the "Domains" section.
  3. Add a Custom Domain:

    • Click on the "Add Domain" button.
    • Enter your desired custom domain name (e.g., www.yourcustomdomain.com).
  4. Generate a Custom Domain (optional):

    • Click on the "Generate Domain" button.
    • Wait for Railway to generate a custom domain.
    • You'll receive a notification when the link is generated, and you can use that link.

This is great when you don't need a custom domain and want clients to see your project quickly. If you need a specific custom domain, please continue to the next step.

  1. Generate DNS Records:

    • Railway will generate DNS records for your custom domain. These records will typically include an A record or a CNAME record.
    • Copy the provided DNS records.
  2. Update DNS Settings with Your Domain Registrar:

    • Log in to your domain registrar (e.g., GoDaddy, Namecheap, Google Domains).
    • Navigate to the DNS settings for your custom domain.
    • Add the DNS records provided by Railway to your domain's DNS settings.
  3. Verify Domain:

    • Return to the Railway dashboard and click on the "Verify" button to confirm that the DNS records are correctly set up.
    • Railway will verify the domain and link it to your project.

Once verified, your custom domain will be pointing to your Railway-hosted application, and you can access it using your new domain name.

Include `RAILWAY_API_TOKEN` for Account-Level Authentication for Railway CLI

Issue

The RAILWAY_API_TOKEN environment variable supports account-level authentication in the Railway CLI, but this is not documented anywhere.

Context

This information was only mentioned by @brody192 in a Railway CLI issue here, but it’s not included in the official documentation. Users like myself may not be aware of this feature, leading to confusion when trying to authenticate the CLI at an account level.

This was an issue when trying to using tools like 1Password's Shell Integration to automatically pass an API token to the CLI from your password manager's vault for example.

Suggestion

Please update the CLI documentation to include a section on using the RAILWAY_API_TOKEN variable, explaining how it can be used for account-level authentication. This should be added somewhere here where CLI authentication is explained.

Better mention of build logs [request]

Right now, the docs don't have great exposure to build logs and how to read / debug them.

All the docs for logs, point to deployment logs. The most typical thing you want to check. But I think there should be more on build logs. The only mention I could find, was https://docs.railway.app/guides/logs#builddeploy-panel.

Somewhere in the https://docs.railway.app/guides/build-configuration (or even a new tab for build logs inside https://docs.railway.app/guides/builds) should have details about where to find the logs and common errors / gotchas.

Please add onto this issue if you can think of any other topics that should be mentioned for this doc additions. But the common issues I see / want talked about:

  • breakdown each section of the log (region vs nixpacks steps vs pushing vs etc)
  • Common issues with long pushes (reasons / how to create smaller build files; like using docker to have staged building)

I am sure there are more important topics in this regard. But these are the main things I can think about / want to see.

Why make this change?
For one, it will help when trying to help someone. Frequently, we ask for logs, and they are very confused or don't send the correct portion of log. Having a page / section to point to, when asking for logs, might help clear things up.

Feedback UI

Clicking yes on did you find this post helpful shows the following:

Screenshot 2023-06-26 at 2 36 17 PM

Default Python Version?

Hi there! I'm a bit of a newbie so I didn't want to open up a PR without asking the question.

The Python docs for Railway state, "The default Python version is 3.6." When I run railway up. I see the following: "Using the buildpack default: 3.10.5." Should I open a PR to update the Railway docs, or is this buildpack default different than what the Railway docs are discussing?

Screen Shot 2022-07-05 at 6 19 15 PM

Search UI design refresh

The search modal currently looks bare. Going to collab w/ @jitachi on this in the coming weeks.

Related to #248, might want a dedicated page we can mount as a modal or something along those lines.

TEST: this is a test

this is a test of the the GH --> CommonRoom --> Zapier --> Discord webhook chain

Compare to heroku page not found

Hi, if you navigate to the "compare to Heroku" page on the docs, you get a page not found:

image

Which is on route https://docs.railway.app/maturity/compare-to-heroku.

If you go from click the "continue reading" button under "what we offer over heroku" on the main heroku page (https://railway.app/heroku), it takes you to it.
image
image

Looks like the href on the continue reading button takes you to https://docs.railway.app/reference/compare-to-heroku.

But, you can't find this tab under "Reference" on docs, and it's instead under the "Maturity" tab which leads to a 404.

I think the ideal fix IMO is to fix the main docs link (put the compare to heroku docs under migrate), and then adjust the link on the https://railway.app/heroku page.

Still Alive?

What's up team. I signed up today for railway but got a notification that I was banned for violating TOS, Ive never used this service before so I'm thinking it could be the VPN (CloudFlare) I use which is prompting the notification. I did try contacting railway via the email link in the footer but I received a messaging back from my mail relay that the user [email protected] does not exist. Anyhow I just thought I'd check with you guys. Thank you.

Legal page not opening when account is banned

This is what I see when I try to login

End of the Line

You've been flagged for violations concerning the Railway ToS. The reason specified is "not mentioning my reason here :)"

If you believe this is in error; please reach out to us via email and we'll get you sorted!

This process is automated, new, and in constant evolution. Apologies for any inconvenience.

When I click on ToS the url on the searchbar changes but nothing happens.

I am facing this on the main page and there is no repo for the main page so I opened this issue here. (Sorry for this)

need to run `yarn add npm-run-all --dev`

following the install and getting started guide, before running railway run yarn dev, I had to do the yarn add npm-run-all dev step. Otherwise, I kept getting lots of command not found errors. Might be worth adding to the doc if you expect folks who are newbs like me to all this.

Your Account is Unverified

Your GitHub Can't Be Verified

Your GitHub might be too new or there might be risky repos on your account that means you can't verify with your GitHub.

Better env var management

We're doing process.env.foo ?? "" and checking for non-empty strings everywhere that uses the env var.

We should centralize this into a config module and perform all the checks upfront in there.

Possible clarification needed when deploying local changes.

Currently the Getting Started doc states:

Once you are done, save the file. In the next step, we will show you how easy it is to deploy your changes.

It seems to imply that this would deploy any uncommitted and un-pushed local changes. We may want to include the clarification of needing to commit and push local changes.

Once you are done, save the file, commit and push to your repo. In the next step, we will show you how easy it is to deploy your changes.

It seems railway up only deploys the latest commit of the main branch. Not uncommitted changed files on our local directory.

PR for review: #179

Java deploy docs incorrect for Spring Boot?

I (successfully!) deployed a Spring Boot-based project and I did not need the "copy dependencies" plugin, nor a Procfile. I only needed to add a system.properties to have it use Java 17.

I'm not sure if the plugin or procfile is needed for other frameworks, but might be worth calling out Spring Boot separately due to its popularity.

External Database SSL Variable / Setting

I don't see any documentation on the location or settings for SSL certification (secure connection) for external database connects.

This would be the environmental variable MYSQL_ATTR_SSL_CA = ????

End of The Line

At present, I have been using Github to log in and use it all the time. Today, I suddenly encountered this situation when logging in to my account, saying that there were multiple accounts. Where did I come from when I logged in with Github and submitted the form without any response? Now, I would like to know the specific reason for the ban? What does this multiple account mean? And I hope you can help me unblock it normally

End of The Line

You've been flagged for violations concerning the Railway [ToS](https://railway.app/legal). The reason specified is "Multiple accounts".

If you believe this is in error; please reach out to us via [email](https://docs.google.com/forms/d/e/1FAIpQLSd8AGaX_7fMgjhCwIFjmRn101BZ8dOa6w44qUL2RT3JOrUzag/viewform?usp=sf_link) and we'll get you sorted!

This process is automated, new, and in constant evolution. Apologies for any inconvenience.

Standardize imports

The way we're importing stuff is scattered: there are relative references (import foo from '../../'), paths-based references (import foo from @/..), and const/default exports are not super clear. It'd be nice to settle on a single convention, tweak the codebase to use that, and enforce it moving forward.

Upgrade Node.js (v16 reached end of life) Version and Next.js for Safety & to Leverage Modern Features

Description

The current documentation for the open-sourced Next.js app for Railway.app is using Node.js version 16.0.0 Node.js version 16 reached its End-of-Life (EOL) on September 2023, leaving the project vulnerable to security risks and missing out on performance improvements in newer versions.

This issue highlights the need to upgrade the following aspects of the project:

  • Node.js: Update to a Long-Term Support (LTS) version like Node.js 18.x or the latest LTS version available at the time of upgrade.
  • Next.js: Due to the Node.js version bump, it would be possible to upgrade Next.js to version 14 or the latest stable version, allowing the project to benefit from performance enhancements and new features.

Benefits of Upgrading:

  • Improved Security: Utilizing a supported Node.js version ensures access to security patches and reduces the risk of vulnerabilities.
  • Enhanced Performance: Upgrading Next.js can offer improved performance and access to new features in the latest version.
  • Modern Development: Maintaining compatibility with current Node.js and Next.js versions allows for safer and more reliable dependency upgrades.

Proposed Solution:

  • Update package.json to specify the latest compatible LTS version of Node.js and the desired Next.js version. This also ensures the app deployed on railway infrastructure use the right node version
  • Update any other dependencies in the project that require Node.js version 18 or higher as needed.
  • Test the application thoroughly after the upgrade to ensure everything functions as intended.

Additional Considerations:

  • This issue focuses on upgrading Node.js and Next.js versions. It's recommended to review the compatibility of all core project dependencies after the Node.js upgrade.
  • We can consider creating a separate pull request for each upgrading the node version and then the next version separately.

Meme

image

End of The Line error when login to my account

Hello, my friends at Railway,

I have tried to login into my railway account today but I have the following blocking error popping up:

"You've been flagged for violations concerning the Railway ToS. The reason specified is "Multiple accounts".
If you believe this is in error; please reach out to us via email and we'll get you sorted!

This process is automated, new, and in constant evolution. Apologies for any inconvenience."

I only have one account please resolve this issue. All my Postgres applications have stopped working. Please resolve it.

Documentation on Scaling

HIi,

I love this deployment ideology having your production mirrored into your local to the bone can really help anyone take off very fast. Just one small request if you could also provide some information on how scale post deployment that could be also very helpful.

Disk space stats

Hi,
There is no information regarding disk space stats. Right now I am on free-tier with 1GB of disk space. Wondering how much disk space my app is using and how much is remaining. Can anyone tell me how can know about disk space stats?

Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.